Skip to main content

Class: FullSubreddit

Hierarchy#

Implements#

  • Identified

Properties#

[nameSymbol]#

• [nameSymbol]: string

Inherited from: Subreddit.[nameSymbol]

Defined in: objects/subreddit/feed.ts:12

activeMemberCount#

• activeMemberCount: number

Defined in: objects/subreddit/full.ts:38

allowDiscovery#

• allowDiscovery: boolean

Defined in: objects/subreddit/full.ts:69

allowGalleries#

• allowGalleries: boolean

Defined in: objects/subreddit/full.ts:70

allowGifs#

• allowGifs: boolean

Defined in: objects/subreddit/full.ts:75

allowImages#

• allowImages: boolean

Defined in: objects/subreddit/full.ts:74

allowPolls#

• allowPolls: boolean

Defined in: objects/subreddit/full.ts:71

allowPredictions#

• allowPredictions: boolean

Defined in: objects/subreddit/full.ts:72

allowPredictionsTournament#

• allowPredictionsTournament: boolean

Defined in: objects/subreddit/full.ts:73

allowVideos#

• allowVideos: boolean

Defined in: objects/subreddit/full.ts:76

banner#

• banner: null | BaseImage

Defined in: objects/subreddit/full.ts:41

bannerColor#

• bannerColor: null | string

Defined in: objects/subreddit/full.ts:45

category#

• category: null | string

Defined in: objects/subreddit/full.ts:35

created#

• created: Date

The time the subreddit was created at

Defined in: objects/subreddit/full.ts:48

description#

• description: Content

Defined in: objects/subreddit/full.ts:33

enabledEmojis#

• enabledEmojis: boolean

Defined in: objects/subreddit/full.ts:65

enabledMediaPreview#

• enabledMediaPreview: boolean

Defined in: objects/subreddit/full.ts:63

enabledOc#

• enabledOc: boolean

Defined in: objects/subreddit/full.ts:67

enabledSpoilers#

• enabledSpoilers: boolean

Defined in: objects/subreddit/full.ts:66

enabledWiki#

• enabledWiki: boolean

Defined in: objects/subreddit/full.ts:64

favorite#

• favorite: boolean

Defined in: objects/subreddit/full.ts:52

fullId#

• fullId: string

Implementation of: Identified.fullId

Defined in: objects/subreddit/full.ts:29

hasMenu#

• hasMenu: boolean

Defined in: objects/subreddit/full.ts:54

icon#

• icon: null | Image

Defined in: objects/subreddit/full.ts:40

id#

• id: string

Implementation of: Identified.id

Defined in: objects/subreddit/full.ts:28

keyColor#

• keyColor: null | string

Defined in: objects/subreddit/full.ts:44

language#

• language: string

Defined in: objects/subreddit/full.ts:50

memberCount#

• memberCount: number

Defined in: objects/subreddit/full.ts:37

name#

• name: string

Inherited from: Subreddit.name

Defined in: objects/subreddit/small.ts:36

nsfw#

• nsfw: boolean

Defined in: objects/subreddit/full.ts:49

primaryColor#

• primaryColor: null | string

Defined in: objects/subreddit/full.ts:43

r#

• r: Reddit

Implementation of: Identified.r

Inherited from: Subreddit.r

Defined in: objects/subreddit/feed.ts:10

shortDescription#

• shortDescription: Content

Defined in: objects/subreddit/full.ts:32

submitLinkLabel#

• submitLinkLabel: null | string

The text seen on the link submit button in the sidebar

Defined in: objects/subreddit/full.ts:57

submitTextLabel#

• submitTextLabel: null | string

The text seen on the text submit button in the sidebar

Defined in: objects/subreddit/full.ts:59

submitTextText#

• submitTextText: Content

The text visible above the text input on the submit page

Defined in: objects/subreddit/full.ts:61

title#

• title: string

Defined in: objects/subreddit/full.ts:31

type#

• type: SubredditType

Defined in: objects/subreddit/full.ts:34

Accessors#

key#

• get key(): string

Returns: string

Defined in: objects/subreddit/small.ts:37

url#

• get url(): string

Returns: string

Defined in: objects/subreddit/small.ts:48

Methods#

ban#

â–¸ ban(user: User, options?: BanOptions): Promise<void>

Parameters#

NameTypeDefault value
userUser-
optionsBanOptions{}

Returns: Promise<void>

Inherited from: Subreddit

Defined in: objects/subreddit/small.ts:222

collections#

â–¸ collections(): Promise<Collection[]>

Returns: Promise<Collection[]>

Defined in: objects/subreddit/full.ts:153

controversial#

â–¸ controversial(options?: TimeOptions): Promise<Page<FullSubmission, any>>

Parameters#

NameType
options?TimeOptions

Returns: Promise<Page<FullSubmission, any>>

Inherited from: Subreddit

Defined in: objects/subreddit/feed.ts:60

fetch#

â–¸ fetch(): Promise<FullSubreddit>

Returns: Promise<FullSubreddit>

Inherited from: Subreddit

Defined in: objects/subreddit/small.ts:64

hot#

â–¸ hot(options?: GetOptions): Promise<Page<FullSubmission, any>>

Parameters#

NameType
options?GetOptions

Returns: Promise<Page<FullSubmission, any>>

Inherited from: Subreddit

Defined in: objects/subreddit/feed.ts:19

inviteModerator#

â–¸ inviteModerator(user: User, permissions?: ModPermission[]): Promise<void>

Parameters#

NameType
userUser
permissions?ModPermission[]

Returns: Promise<void>

Inherited from: Subreddit

Defined in: objects/subreddit/small.ts:146

isReal#

â–¸ isReal(): boolean

Returns: boolean

Inherited from: Subreddit

Defined in: objects/subreddit/small.ts:52

join#

â–¸ join(join?: boolean): Promise<void>

Parameters#

NameTypeDefault value
joinbooleantrue

Returns: Promise<void>

Inherited from: Subreddit

Defined in: objects/subreddit/small.ts:251

moderators#

â–¸ moderators(): Promise<ModRelation[]>

Returns: Promise<ModRelation[]>

Inherited from: Subreddit

Defined in: objects/subreddit/small.ts:128

mute#

â–¸ mute(user: User): Promise<void>

Parameters#

NameType
userUser

Returns: Promise<void>

Inherited from: Subreddit

Defined in: objects/subreddit/small.ts:200

new#

â–¸ new(options?: GetOptions): Promise<Page<FullSubmission, any>>

Parameters#

NameType
options?GetOptions

Returns: Promise<Page<FullSubmission, any>>

Inherited from: Subreddit

Defined in: objects/subreddit/feed.ts:29

randomSubmission#

â–¸ randomSubmission(): Promise<FullSubmission>

Returns: Promise<FullSubmission>

Inherited from: Subreddit

Defined in: objects/subreddit/small.ts:345

removeModerator#

â–¸ removeModerator(user: User): Promise<void>

Parameters#

NameType
userUser

Returns: Promise<void>

Inherited from: Subreddit

Defined in: objects/subreddit/small.ts:189

removeModeratorInvite#

â–¸ removeModeratorInvite(user: User): Promise<void>

Parameters#

NameType
userUser

Returns: Promise<void>

Inherited from: Subreddit

Defined in: objects/subreddit/small.ts:178

requirements#

â–¸ requirements(): Promise<Requirements>

Returns: Promise<Requirements>

Inherited from: Subreddit

Defined in: objects/subreddit/small.ts:271

rising#

â–¸ rising(options?: GetOptions): Promise<Page<FullSubmission, any>>

Parameters#

NameType
options?GetOptions

Returns: Promise<Page<FullSubmission, any>>

Inherited from: Subreddit

Defined in: objects/subreddit/feed.ts:51

rules#

â–¸ rules(): Promise<Rule[]>

Returns: Promise<Rule[]>

Inherited from: Subreddit

Defined in: objects/subreddit/small.ts:262

searchSubmission#

â–¸ searchSubmission(query: string, options?: SubmissionSearchOptions): Promise<Page<FullSubmission, any>>

Parameters#

NameType
querystring
options?SubmissionSearchOptions

Returns: Promise<Page<FullSubmission, any>>

Inherited from: Subreddit

Defined in: objects/subreddit/small.ts:353

setModeratorPermissions#

â–¸ setModeratorPermissions(user: User, permissions: ModPermission[]): Promise<void>

Parameters#

NameType
userUser
permissionsModPermission[]

Returns: Promise<void>

Inherited from: Subreddit

Defined in: objects/subreddit/small.ts:164

sticky#

â–¸ sticky(num?: 1 | 2): Promise<FullSubmission>

Parameters#

NameTypeDefault value
num1 | 21

Returns: Promise<FullSubmission>

Inherited from: Subreddit

Defined in: objects/subreddit/small.ts:337

style#

â–¸ style(): Promise<Style>

Get structured subreddit styles

Returns: Promise<Style>

Inherited from: Subreddit

Defined in: objects/subreddit/small.ts:103

stylesheet#

â–¸ stylesheet(): Promise<string>

Returns: Promise<string>

Inherited from: Subreddit

Defined in: objects/subreddit/small.ts:71

submissionsStream#

â–¸ submissionsStream(options?: StreamOptions): AsyncIterator<FullSubmission, any, undefined>

Parameters#

NameType
options?StreamOptions

Returns: AsyncIterator<FullSubmission, any, undefined>

Inherited from: Subreddit

Defined in: objects/subreddit/feed.ts:73

submitCrosspost#

â–¸ submitCrosspost(title: string, submission: Submission, options?: NewSubmissionOptions): Promise<Submission>

Parameters#

NameType
titlestring
submissionSubmission
options?NewSubmissionOptions

Returns: Promise<Submission>

Inherited from: Subreddit

Defined in: objects/subreddit/small.ts:416

submitLink#

â–¸ submitLink(title: string, url: string, options?: NewSubmissionOptions): Promise<Submission>

Parameters#

NameType
titlestring
urlstring
options?NewSubmissionOptions

Returns: Promise<Submission>

Inherited from: Subreddit

Defined in: objects/subreddit/small.ts:369

submitMedia#

â–¸ submitMedia(title: string, file: Stream, name: string, mimetype: string, options?: NewSubmissionOptions): Promise<Submission>

Parameters#

NameType
titlestring
fileStream
namestring
mimetypestring
options?NewSubmissionOptions

Returns: Promise<Submission>

Inherited from: Subreddit

Defined in: objects/subreddit/small.ts:387

submitPoll#

â–¸ submitPoll(title: string, body: undefined | string, items: string[], duration: number, options?: NewSubmissionOptions): Promise<Submission>

Parameters#

NameType
titlestring
bodyundefined | string
itemsstring[]
durationnumber
options?NewSubmissionOptions

Returns: Promise<Submission>

Inherited from: Subreddit

Defined in: objects/subreddit/small.ts:399

submitText#

â–¸ submitText(title: string, body?: string, options?: NewSubmissionOptions): Promise<Submission>

Parameters#

NameType
titlestring
body?string
options?NewSubmissionOptions

Returns: Promise<Submission>

Inherited from: Subreddit

Defined in: objects/subreddit/small.ts:378

top#

â–¸ top(options?: TimeOptions): Promise<Page<FullSubmission, any>>

Parameters#

NameType
options?TimeOptions

Returns: Promise<Page<FullSubmission, any>>

Inherited from: Subreddit

Defined in: objects/subreddit/feed.ts:38

traffic#

â–¸ traffic(): Promise<Traffics>

Returns: Promise<Traffics>

Inherited from: Subreddit

Defined in: objects/subreddit/small.ts:304

unban#

â–¸ unban(user: User): Promise<void>

Parameters#

NameType
userUser

Returns: Promise<void>

Inherited from: Subreddit

Defined in: objects/subreddit/small.ts:240

unmute#

â–¸ unmute(user: User): Promise<void>

Parameters#

NameType
userUser

Returns: Promise<void>

Inherited from: Subreddit

Defined in: objects/subreddit/small.ts:211

widgets#

â–¸ widgets(): Promise<Widgets>

Returns: Promise<Widgets>

Inherited from: Subreddit

Defined in: objects/subreddit/small.ts:79