Class: Reddit

Constructors

constructor

+ new Reddit(data: RedditConstructor): Reddit

Parameters

Name	Type
data	RedditConstructor

Returns: Reddit

Defined in: reddit.ts:31

Properties

auth

• Optional auth: Auth

Defined in: reddit.ts:29

---

linkUrl

• linkUrl: string= "https://www.reddit.com"

Defined in: reddit.ts:31

Accessors

all

• get all(): Subreddit

The r/all pseudo subreddit

Returns: Subreddit

Defined in: reddit.ts:219

---

self

• get self(): null | Self

Returns: null | Self

Defined in: reddit.ts:227

Methods

collection

▸ collection(id: string): Promise<Collection>

Parameters

Name	Type
id	string

Returns: Promise<Collection>

Defined in: reddit.ts:232

---

login

▸ login(data: AuthData): Promise<void>

Parameters

Name	Type
data	AuthData

Returns: Promise<void>

Defined in: reddit.ts:54

---

oauth

▸ oauth(clientId: string, redirectUri: string, scopes: Scope[], temporary?: boolean): string

Parameters

Name	Type
clientId	string
redirectUri	string
scopes	Scope[]
temporary?	boolean

Returns: string

Defined in: reddit.ts:154

---

searchSubmission

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

Parameters

Name	Type
query	string
options?	SubmissionSearchOptions

Returns: Promise<Page<FullSubmission, any>>

Defined in: reddit.ts:248

---

searchSubreddit

▸ searchSubreddit(query: string, options?: SearchOptions): Promise<Page<FullSubreddit, any>>

Search subreddits by title and description

Parameters

Name	Type
query	string
options?	SearchOptions

Returns: Promise<Page<FullSubreddit, any>>

Defined in: reddit.ts:264

---

searchUser

▸ searchUser(query: string, options?: SearchOptions): Promise<Page<FullUser, any>>

Parameters

Name	Type
query	string
options?	SearchOptions

Returns: Promise<Page<FullUser, any>>

Defined in: reddit.ts:279

---

submission

▸ submission(id: string): Submission

Get a submission

example Get the title of a submission

const s = await r.submission("87").fetch();

console.log(s.title); // The Downing Street Memo

Parameters

Name	Type	Description
id	string	The id with or without a prefix

Returns: Submission

Defined in: reddit.ts:209

---

subreddit

▸ subreddit(...names: string[]): Subreddit

Parameters

Name	Type
...names	string[]

Returns: Subreddit

Defined in: reddit.ts:214

---

trendingSubreddits

▸ trendingSubreddits(): Promise<Subreddit[]>

Returns: Promise<Subreddit[]>

Defined in: reddit.ts:240

---

user

▸ user(name: string): User

Parameters

Name	Type
name	string

Returns: User

Defined in: reddit.ts:223