Add a user to the list of approved wiki editors.
The name of the subreddit to add the user to.
The username of the user to add.
A promise that resolves when the wiki editor has been added.
Ban a user from a subreddit.
The name of the subreddit to ban the user from.
The username of the user to ban.
Any additional options for the ban.
A promise that resolves when the user has been banned.
Get the list of banned users for a subreddit.
The name of the subreddit to get banned users for.
A listing of banned users.
Due to the way Reddit implements Listings, this will only contain the first 1000 banned users.
Get the list of approved contributors for a subreddit.
The name of the subreddit to get contributors for.
A listing of approved contributors.
Due to the way Reddit implements Listings, this will only contain the first 1000 contributors.
Get the posts in a subreddit, sorted by controversial.
Optional
subreddit: stringThe name of the subreddit. If this is left off it will query the front page of Reddit.
The time scale to filter by.
A listing of posts, with the most controversial ones first.
Due to the way Reddit implements Listings, this will only contain the first 1000 posts.
Get the posts in a subreddit, sorted by hot.
Optional
subreddit: stringThe name of the subreddit. If this is left off it will query the front page of Reddit.
A listing of posts, with the hottest ones first.
Due to the way Reddit implements Listings, this will only contain the first 1000 posts.
Get the list of flair templates for a subreddit.
The name of the subreddit.
A promise that resolves to a list of flair templates.
Get the list of muted users for a subreddit.
The name of the subreddit to get muted users for.
A listing of muted users.
Due to the way Reddit implements Listings, this will only contain the first 1000 muted users.
Get the posts in a subreddit, sorted by new.
Optional
subreddit: stringThe name of the subreddit. If this is left off it will query the front page of Reddit.
A listing of posts, with the newest ones first.
Due to the way Reddit implements Listings, this will only contain the first 1000 posts.
Get the post requirements for this subreddit.
The name of the subreddit.
A promise that resolves to the PostRequirements for this subreddit.
Get the posts in a subreddit, sorted by rising.
Optional
subreddit: stringThe name of the subreddit. If this is left off it will query the front page of Reddit.
A listing of posts, with the rising ones first.
Due to the way Reddit implements Listings, this will only contain the first 1000 posts.
Get a Listing of all the comments in a subreddit.
The subreddit to get comments from. If this is not provided comments will be fetched from the front page of Reddit.
How to sort the comments.
A sorted Listing of comments.
Due to the way Reddit implements Listings, this will only contain the first 1000 comments.
Get the posts in a subreddit, sorted by top.
Optional
subreddit: stringThe name of the subreddit. If this is left off it will query the front page of Reddit.
The time scale to filter by.
A listing of posts, with the top rated ones first.
Due to the way Reddit implements Listings, this will only contain the first 1000 posts.
Get the list of approved wiki contributors for a subreddit.
The name of the subreddit to get wiki contributors for.
A listing of approved wiki contributors.
Due to the way Reddit implements Listings, this will only contain the first 1000 wiki contributors.
Get the list of wikibanned users for a subreddit.
The name of the subreddit to get wikibanned users for.
A listing of wikibanned users.
Due to the way Reddit implements Listings, this will only contain the first 1000 wikibanned users.
Submit a crosspost.
The subreddit to submit the post to.
The title of the post.
The ID of the post to crosspost.
Any extra options.
A promise that resolves to the ID of the new post.
Submit a gallery post.
Options for submitting a gallery post.
A promise that resolves to the ID of the new post.
Submit an image post.
The subreddit to submit the post to.
The title of the post.
The image file to post.
The name of the image file.
Whether to disable websockets for the image.
Any extra options.
A promise that resolves to the ID of the new post or undefined
Submit a link post.
The subreddit to submit the post to.
The title of the post.
The url to link to.
Any extra options.
A promise that resolves to the ID of the new post.
Submit a text post.
The subreddit to submit the post to.
The title of the post.
Optional
body: stringThe body of the post.
Any extra options.
A promise that resolves to the ID of the new post.
Submit a video post.
The subreddit to submit the post to.
The title of the post.
The video file to post.
The name of the video file.
The thumbnail file to use.
The name of the thumbnail file.
Whether the video is a gif.
Whether to disable websockets for the video.
Any extra options.
A promise that resolves to the ID of the new post or undefined
Remove an approved poster.
The name of the subreddit to remove the contributor from.
The username of the user to remove.
A promise that resolves when the contributor has been removed.
Remove a user from the list of approved wiki editors.
The name of the subreddit to remove the user from.
The username of the user to remove.
A promise that resolves when the wiki editor has been removed.
Search in a subreddit.
The subreddit to search in.
The search query.
The time range to search in.
The way to sort the search results.
The search syntax to use.
A listing of posts.
Due to the way Reddit implements Listings, this will only contain the first 1000 posts.
Generated using TypeDoc
Various methods to allow you to interact with subreddits.