Class BaseUserControls

The base controls for interacting with users.

Hierarchy (view full)

BaseControls
- BaseUserControls
  - MyUserControls
  - UserControls

Index

Methods

fetchSubreddit getPosts getSortedComments namespace

Methods

fetchSubreddit

fetchSubreddit(username): Promise<Subreddit>
Fetch a user's subreddit.
Parameters
- username: string
  The user who's subreddit to fetch.
Returns Promise<Subreddit>
A promise that resolves to the user's subreddit.
- Defined in reddit/user/base/controls.ts:39

getPosts

getPosts(username, sort?): Listing<Post>
Get a Listing of all the posts a user has made.
Parameters
- username: string
  The user to get posts from.
- sort: PostSort = "new"
  How to sort the posts.
Returns Listing<Post>
A sorted Listing of posts.
- Defined in reddit/user/base/controls.ts:51

getSortedComments

getSortedComments(username, sort?): Listing<Comment>
Get a Listing of all the comments a user has made.
Parameters
- username: string
  The user to get comments from.
- sort: UserItemsSort = "new"
  How to sort the comments.
Returns Listing<Comment>
A sorted Listing of comments.
- Defined in reddit/user/base/controls.ts:65

namespace

namespace(id): string
Namespace an id with the proper prefix for its type.
Parameters
- id: string
  The ID to namespace.
Returns string
The namespaced version of the id.
Inherited from BaseControls.namespace
- Defined in reddit/base-controls.ts:27

Generated using TypeDoc