Class Subreddit

accountsActiveIsFuzzed

activeUserCount

allOriginalContent

allowChatPostCreation

allowDiscovery

allowGalleries

allowImages

allowPolls

allowPredictions

allowPredictionsTournament

allowVideogifs

allowVideos

bannerBackgroundColor

bannerBackgroundImage

bannerImg

bannerSize

canAssignLinkFlair

canAssignUserFlair

coins

collapseDeletedComments

commentScoreHideMins

communityIcon

description

descriptionHtml

displayName

displayNamePrefixed

emojisCustomSize

emojisEnabled

freeFormReports

headerImg

headerSize

headerTitle

hideAds

linkFlairEnabled

linkFlairPosition

originalContentTagEnabled

over18

publicTraffic

quarantine

restrictCommenting

restrictPosting

showMedia

showMediaPreview

sidebar

sidebarHtml

spoilersEnabled

submissionType

submitLinkLabel

submitText

submitTextHtml

submitTextLabel

subredditType

subscribers

title

url

userHasFavorited

userIsBanned

userIsContributor

userIsModerator

userIsMuted

userIsSubscriber

userSrFlairEnabled

userSrThemeEnabled

wikiEnabled

acceptModeratorInvite

• acceptModeratorInvite(): Promise<void>

• Accept a moderator invite.

  Returns Promise<void>

  A promise that resolves when the invite has been accepted.

addContributor

• addContributor(username): Promise<void>

• Add an approved poster.

  Parameters

  • username: string

    The username of the user to add.

  Returns Promise<void>

  A promise that resolves when the contributor has been added.

addWikiContributor

• addWikiContributor(username): Promise<void>

• Add a user to the list of approved wiki editors.

  Parameters

  • username: string

    The username of the user to add.

  Returns Promise<void>

  A promise that resolves when the wiki editor has been added.

banUser

• banUser(username, options?): Promise<void>

• Ban a user from this subreddit.

  Parameters

  • username: string

    The username of the user to ban.
  • options: BanOptions = {}

    Any additional options for the ban.

  Returns Promise<void>

  A promise that resolves when the user has been banned.

getBannedUsers

• getBannedUsers(): Listing<BannedUser>

• Get the list of banned users for this subreddit.

  Returns Listing<BannedUser>

  A listing of banned users.

  Note

  Due to the way Reddit implements Listings, this will only contain the first 1000 banned users.

getContributors

• getContributors(): Listing<ModeratorActionedUser>

• Get the list of approved contributors for this subreddit.

  Returns Listing<ModeratorActionedUser>

  A listing of approved contributors.

  Note

  Due to the way Reddit implements Listings, this will only contain the first 1000 contributors.

getControversialPosts

• getControversialPosts(time?): Listing<Post>

• Get the posts in this subreddit, sorted by controversial.

  Parameters

  • time: TimeRange = "all"

    The time scale to filter by.

  Returns Listing<Post>

  A listing of posts, with the most controversial ones first.

  Note

  Due to the way Reddit implements Listings, this will only contain the first 1000 posts.

getEdited

• getEdited(): Listing<Comment | Post>

• Get the list of items that have been edited from this subreddit.

  Returns Listing<Comment | Post>

  A listing of items that have been edited.

getEditedComments

• getEditedComments(): Listing<Comment>

• Get the list of comments that have been edited from this subreddit.

  Returns Listing<Comment>

  A listing of comments that have been edited.

getEditedPosts

• getEditedPosts(): Listing<Post>

• Get the list of posts that have been edited from this subreddit.

  Returns Listing<Post>

  A listing of posts that have been edited.

getHotPosts

• getHotPosts(): Listing<Post>

• Get the posts in this subreddit, sorted by hot.

  Returns Listing<Post>

  A listing of posts, with the hottest ones first.

  Note

  Due to the way Reddit implements Listings, this will only contain the first 1000 posts.

getLinkFlairTemplates

• getLinkFlairTemplates(): Promise<SubredditFlair[]>

• Get link flair templates for this subreddit.

  Returns Promise<SubredditFlair[]>

  A promise that resolves to an array of link flair templates.

getModerators

• getModerators(): Promise<Moderator[]>

• Get the list of moderators for this subreddit.

  Returns Promise<Moderator[]>

  A listing of moderators.

  Note

  Due to the way Reddit implements Listings, this will only contain the first 1000 moderators.

getModqueue

• getModqueue(): Listing<Comment | Post>

• Get the list of items that are in the modqueue of this subreddit.

  Returns Listing<Comment | Post>

  A listing of items that are in the modqueue.

getModqueueComments

• getModqueueComments(): Listing<Comment>

• Get the list of comments that are in the modqueue of this subreddit.

  Returns Listing<Comment>

  A listing of comments that are in the modqueue.

getModqueuePosts

• getModqueuePosts(): Listing<Post>

• Get the list of posts that are in the modqueue of this subreddit.

  Returns Listing<Post>

  A listing of posts that are in the modqueue.

getMutedUsers

• getMutedUsers(): Listing<ModeratorActionedUser>

• Get the list of muted users for this subreddit.

  Returns Listing<ModeratorActionedUser>

  A listing of muted users.

  Note

  Due to the way Reddit implements Listings, this will only contain the first 1000 muted users.

getNewPosts

• getNewPosts(): Listing<Post>

• Get the posts in this subreddit, sorted by new.

  Returns Listing<Post>

  A listing of posts, with the newest ones first.

  Note

  Due to the way Reddit implements Listings, this will only contain the first 1000 posts.

getPostRequirements

• getPostRequirements(): Promise<PostRequirements>

• Get the post requirements for this subreddit.

  Returns Promise<PostRequirements>

  A promise that resolves to the PostRequirements for this subreddit.

getRandomPostId

• getRandomPostId(): Promise<string>

• Get the ID of a random post from this subreddit.

  Returns Promise<string>

  A promise that resolves to a random post ID.

getReported

• getReported(): Listing<Comment | Post>

• Get the list of items that have been reported from this subreddit.

  Returns Listing<Comment | Post>

  A listing of items that have been reported.

getReportedComments

• getReportedComments(): Listing<Comment>

• Get the list of comments that have been reported from this subreddit.

  Returns Listing<Comment>

  A listing of comments that have been reported.

getReportedPosts

• getReportedPosts(): Listing<Post>

• Get the list of posts that have been reported from this subreddit.

  Returns Listing<Post>

  A listing of posts that have been reported.

getRisingPosts

• getRisingPosts(): Listing<Post>

• Get the posts in this subreddit, sorted by rising.

  Returns Listing<Post>

  A listing of posts, with the rising ones first.

  Note

  Due to the way Reddit implements Listings, this will only contain the first 1000 posts.

getSortedComments

• getSortedComments(sort?): Listing<Comment>

• Get a Listing of all the comments in this subreddit.

  Parameters

  • sort: "new" = "new"

    How to sort the comments.

  Returns Listing<Comment>

  A sorted Listing of comments.

  Note

  Due to the way Reddit implements Listings, this will only contain the first 1000 posts.

getSpam

• getSpam(): Listing<Comment | Post>

• Get the list of items that have been removed from this subreddit.

  Returns Listing<Comment | Post>

  A listing of items that have been removed.

getSpamComments

• getSpamComments(): Listing<Comment>

• Get the list of comments that have been removed from this subreddit.

  Returns Listing<Comment>

  A listing of comments that have been removed.

getSpamPosts

• getSpamPosts(): Listing<Post>

• Get the list of posts that have been removed from this subreddit.

  Returns Listing<Post>

  A listing of posts that have been removed.

getTopPosts

• getTopPosts(time?): Listing<Post>

• Get the posts in this subreddit, sorted by top.

  Parameters

  • time: TimeRange = "all"

    The time scale to filter by.

  Returns Listing<Post>

  A listing of posts, with the top rated ones first.

  Note

  Due to the way Reddit implements Listings, this will only contain the first 1000 posts.

getUnmoderated

• getUnmoderated(): Listing<Comment | Post>

• Get the list of items that have not been moderated from this subreddit.

  Returns Listing<Comment | Post>

  A listing of items that have not been moderated.

getUnmoderatedComments

• getUnmoderatedComments(): Listing<Comment>

• Get the list of comments that have not been moderated from this subreddit.

  Returns Listing<Comment>

  A listing of comments that have not been moderated.

getUnmoderatedPosts

• getUnmoderatedPosts(): Listing<Post>

• Get the list of posts that have not been moderated from this subreddit.

  Returns Listing<Post>

  A listing of posts that have not been moderated.

getWikiContributors

• getWikiContributors(): Listing<ModeratorActionedUser>

• Get the list of approved wiki contributors for a subreddit.

  Returns Listing<ModeratorActionedUser>

  A listing of approved wiki contributors.

  Note

  Due to the way Reddit implements Listings, this will only contain the first 1000 wiki contributors.

getWikibannedUsers

• getWikibannedUsers(): Listing<BannedUser>

• Get the list of wikibanned users for this subreddit.

  Returns Listing<BannedUser>

  A listing of wikibanned users.

  Note

  Due to the way Reddit implements Listings, this will only contain the first 1000 wikibanned users.

leaveContributor

• leaveContributor(): Promise<void>

• Remove yourself (the authorized user) from the list of approved posters.

  Returns Promise<void>

  A promise that resolves when you have been successfully removed.

muteUser

• muteUser(username): Promise<void>

• Mute a user in this subreddit.

  This prevents the user from sending modmail to this subreddit for 72 hours.

  Parameters

  • username: string

    The username of the user to mute.

  Returns Promise<void>

postCrosspost

• postCrosspost(title, postID, options?): Promise<string>

• Submit a crosspost.

  Parameters

  • title: string

    The title of the post.
  • postID: string

    The ID of the post to crosspost.
  • options: LinkPostOptions = {}

    Any extra options.

  Returns Promise<string>

  A promise that resolves to the ID of the new post.

postGallery

• postGallery(params): Promise<string>

• Submit a gallery post.

  Parameters

  • params: Omit<GalleryPostOptions, "subreddit">

    Options for submitting a gallery post.

  Returns Promise<string>

  A promise that resolves to the ID of the new post.

postImage

• postImage(title, imageFile, imageFileName, noWebsockets?, options?): Promise<undefined | string>

• Submit an image post to this subreddit.

  Parameters

  • title: string

    The title of the post.
  • imageFile: Blob

    The image to post.
  • imageFileName: string

    The name of the image file.
  • noWebsockets: boolean = false

    Whether to disable websockets for the image.
  • options: LinkPostOptions = {}

    Any extra options.

  Returns Promise<undefined | string>

  A promise that resolves to the ID of the new post or undefined

postLink

• postLink(title, url, options?): Promise<string>

• Submit a link post to this subreddit.

  Parameters

  • title: string

    The title of the post.
  • url: string

    The url to link to.
  • options: LinkPostOptions = {}

    Any extra options.

  Returns Promise<string>

  A promise that resolves to the ID of the new post.

postText

• postText(title, body?, options?): Promise<string>

• Submit a text post to this subreddit.

  Parameters

  • title: string

    The title of the post.
  • Optional body: string

    The body of the post.
  • options: TextPostOptions = {}

    Any extra options.

  Returns Promise<string>

  A promise that resolves to the ID of the new post.

postVideo

• postVideo(title, videoFile, videoFileName, thumbnailFile, thumbnailFileName, videoGif?, noWebsockets?, options?): Promise<undefined | string>

• Submit a video post.

  Parameters

  • title: string

    The title of the post.
  • videoFile: Blob

    The video file to post.
  • videoFileName: string

    The name of the video file.
  • thumbnailFile: Blob

    The thumbnail file to use.
  • thumbnailFileName: string

    The name of the thumbnail file.
  • videoGif: boolean = false

    Whether the video is a gif.
  • noWebsockets: boolean = false

    Whether to disable websockets for the video.
  • options: LinkPostOptions = {}

    Any extra options.

  Returns Promise<undefined | string>

  A promise that resolves to the ID of the new post or undefined

refetch

• refetch(): Promise<Subreddit>

• Re-fetch this subreddit.

  Note: This returns a new object, it is not mutating.

  Returns Promise<Subreddit>

  A promise that resolves to the newly fetched subreddit.

removeContributor

• removeContributor(username): Promise<void>

• Remove an approved poster.

  Parameters

  • username: string

    The username of the user to remove.

  Returns Promise<void>

  A promise that resolves when the contributor has been removed.

removeWikiContributor

• removeWikiContributor(username): Promise<void>

• Remove a user from the list of approved wiki editors.

  Parameters

  • username: string

    The username of the user to remove.

  Returns Promise<void>

  A promise that resolves when the wiki editor has been removed.

search

• search(query, time?, sort?, syntax?): Listing<Post>

• Search in this subreddit.

  Parameters

  • query: string

    The search query.
  • time: TimeRange = "all"

    The time range to search in.
  • sort: SearchSort = "relevance"

    The way to sort the search results.
  • syntax: SearchSyntax = "plain"

    The search syntax to use.

  Returns Listing<Post>

  A listing of posts.

unbanUser

• unbanUser(username): Promise<void>

• Unban a user from this subreddit.

  Parameters

  • username: string

    The username of the user to unban.

  Returns Promise<void>

  A promise that resolves when the user has been unbanned.

unmuteUser

• unmuteUser(username): Promise<void>

• Unmute a user in this subreddit.

  Parameters

  • username: string

    The username of the user to unmute.

  Returns Promise<void>

unwikibanUser

• unwikibanUser(username): Promise<void>

• Unban a user from editing this subreddit's wiki

  Parameters

  • username: string

    The username of the user to wikiban.

  Returns Promise<void>

wikibanUser

• wikibanUser(username): Promise<void>

• Ban a user from editing this subreddit's wiki.

  Parameters

  • username: string

    The username of the user to wikiban.

  Returns Promise<void>