Class: Subreddit

Hierarchy

• Feed

  ↳ Subreddit

  ↳↳ FullSubreddit

Implements

• Fetchable<FullSubreddit>

Properties

[nameSymbol]

• [nameSymbol]: string

Inherited from: Feed.__@nameSymbol@4220

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

---

name

• name: string

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

---

r

• r: Reddit

Inherited from: Feed.r

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

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

Name	Type	Default value
user	User	-
options	BanOptions	{}

Returns: Promise<void>

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

---

controversial

▸ controversial(options?: TimeOptions): Promise<Page<FullSubmission, any>>

Parameters

Name	Type
options?	TimeOptions

Returns: Promise<Page<FullSubmission, any>>

Inherited from: Feed.controversial

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

---

fetch

▸ fetch(): Promise<FullSubreddit>

Returns: Promise<FullSubreddit>

Implementation of: Fetchable.fetch

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

---

hot

▸ hot(options?: GetOptions): Promise<Page<FullSubmission, any>>

Parameters

Name	Type
options?	GetOptions

Returns: Promise<Page<FullSubmission, any>>

Inherited from: Feed.hot

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

---

inviteModerator

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

Parameters

Name	Type
user	User
permissions?	ModPermission[]

Returns: Promise<void>

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

---

isReal

▸ isReal(): boolean

Returns: boolean

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

---

join

▸ join(join?: boolean): Promise<void>

Parameters

Name	Type	Default value
join	boolean	true

Returns: Promise<void>

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

---

moderators

▸ moderators(): Promise<ModRelation[]>

Returns: Promise<ModRelation[]>

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

---

mute

▸ mute(user: User): Promise<void>

Parameters

Name	Type
user	User

Returns: Promise<void>

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

---

new

▸ new(options?: GetOptions): Promise<Page<FullSubmission, any>>

Parameters

Name	Type
options?	GetOptions

Returns: Promise<Page<FullSubmission, any>>

Inherited from: Feed.new

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

---

randomSubmission

▸ randomSubmission(): Promise<FullSubmission>

Returns: Promise<FullSubmission>

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

---

removeModerator

▸ removeModerator(user: User): Promise<void>

Parameters

Name	Type
user	User

Returns: Promise<void>

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

---

removeModeratorInvite

▸ removeModeratorInvite(user: User): Promise<void>

Parameters

Name	Type
user	User

Returns: Promise<void>

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

---

requirements

▸ requirements(): Promise<Requirements>

Returns: Promise<Requirements>

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

---

rising

▸ rising(options?: GetOptions): Promise<Page<FullSubmission, any>>

Parameters

Name	Type
options?	GetOptions

Returns: Promise<Page<FullSubmission, any>>

Inherited from: Feed.rising

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

---

rules

▸ rules(): Promise<Rule[]>

Returns: Promise<Rule[]>

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

---

searchSubmission

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

Parameters

Name	Type
query	string
options?	SubmissionSearchOptions

Returns: Promise<Page<FullSubmission, any>>

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

---

setModeratorPermissions

▸ setModeratorPermissions(user: User, permissions: ModPermission[]): Promise<void>

Parameters

Name	Type
user	User
permissions	ModPermission[]

Returns: Promise<void>

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

---

sticky

▸ sticky(num?: 1 | 2): Promise<FullSubmission>

Parameters

Name	Type	Default value
num	1 | 2	1

Returns: Promise<FullSubmission>

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

---

style

▸ style(): Promise<Style>

Get structured subreddit styles

Returns: Promise<Style>

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

---

stylesheet

▸ stylesheet(): Promise<string>

Returns: Promise<string>

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

---

submissionsStream

▸ submissionsStream(options?: StreamOptions): AsyncIterator<FullSubmission, any, undefined>

Parameters

Name	Type
options?	StreamOptions

Returns: AsyncIterator<FullSubmission, any, undefined>

Inherited from: Feed.submissionsStream

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

---

submitCrosspost

▸ submitCrosspost(title: string, submission: Submission, options?: NewSubmissionOptions): Promise<Submission>

Parameters

Name	Type
title	string
submission	Submission
options?	NewSubmissionOptions

Returns: Promise<Submission>

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

---

submitLink

▸ submitLink(title: string, url: string, options?: NewSubmissionOptions): Promise<Submission>

Parameters

Name	Type
title	string
url	string
options?	NewSubmissionOptions

Returns: Promise<Submission>

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

---

submitMedia

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

Parameters

Name	Type
title	string
file	Stream
name	string
mimetype	string
options?	NewSubmissionOptions

Returns: Promise<Submission>

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

---

submitPoll

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

Parameters

Name	Type
title	string
body	undefined | string
items	string[]
duration	number
options?	NewSubmissionOptions

Returns: Promise<Submission>

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

---

submitText

▸ submitText(title: string, body?: string, options?: NewSubmissionOptions): Promise<Submission>

Parameters

Name	Type
title	string
body?	string
options?	NewSubmissionOptions

Returns: Promise<Submission>

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

---

top

▸ top(options?: TimeOptions): Promise<Page<FullSubmission, any>>

Parameters

Name	Type
options?	TimeOptions

Returns: Promise<Page<FullSubmission, any>>

Inherited from: Feed.top

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

---

traffic

▸ traffic(): Promise<Traffics>

Returns: Promise<Traffics>

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

---

unban

▸ unban(user: User): Promise<void>

Parameters

Name	Type
user	User

Returns: Promise<void>

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

---

unmute

▸ unmute(user: User): Promise<void>

Parameters

Name	Type
user	User

Returns: Promise<void>

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

---

widgets

▸ widgets(): Promise<Widgets>

Returns: Promise<Widgets>

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