Class UserControls

Various methods to allow you to interact with users.

Hierarchy (view full)

BaseUserControls
- UserControls

Index

Methods

fetch fetchSubreddit getPosts getSortedComments isUsernameAvailable namespace

Methods

fetch

fetch(username): Promise<User>
Fetch a user from Reddit.
Parameters
- username: string
  The name of the user to fetch.
Returns Promise<User>
The user.

Note
If the username you fetch is the same as the authorized user this will return a MyUser instance. Otherwise it will be an instance of OtherUser. To tell dynamically you can use User.isMe.
- Defined in reddit/user/other-user/controls.ts:23

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.
Inherited from BaseUserControls.fetchSubreddit
- 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.
Inherited from BaseUserControls.getPosts
- 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.
Inherited from BaseUserControls.getSortedComments
- Defined in reddit/user/base/controls.ts:65

isUsernameAvailable

isUsernameAvailable(username): Promise<boolean>
Check whether whether or not a username is available.
Parameters
- username: string
  The username to check.
Returns Promise<boolean>
Whether or not the username is available.
- Defined in reddit/user/other-user/controls.ts:35

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 BaseUserControls.namespace
- Defined in reddit/base-controls.ts:27

Generated using TypeDoc