Class: FullUser

Hierarchy#

User
↳ FullUser

Implements#

Identified

Properties#

admin#

• admin: boolean

Defined in: objects/user/full.ts:22

avatar#

• avatar: null | Image

Defined in: objects/user/full.ts:14

awardeeKarma#

• awardeeKarma: number

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

awarderKarma#

• awarderKarma: number

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

banner#

• banner: null | Image

Defined in: objects/user/full.ts:15

commentKarma#

• commentKarma: number

Defined in: objects/user/full.ts:30

created#

• created: Date

Defined in: objects/user/full.ts:17

description#

• description: null | string

Defined in: objects/user/full.ts:11

displayName#

• displayName: string

Defined in: objects/user/full.ts:10

fullId#

• fullId: string

Implementation of: Identified.fullId

Defined in: objects/user/full.ts:8

icon#

• icon: Image

Defined in: objects/user/full.ts:13

id#

• id: string

Implementation of: Identified.id

Defined in: objects/user/full.ts:7

karma#

• karma: number

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

mod#

• mod: boolean

Defined in: objects/user/full.ts:21

name#

• name: string

Inherited from: User.name

Defined in: objects/user/small.ts:16

nsfw#

• nsfw: boolean

Defined in: objects/user/full.ts:19

premium#

• premium: boolean

Defined in: objects/user/full.ts:20

r#

• r: Reddit

Implementation of: Identified.r

Inherited from: User.r

Defined in: objects/user/small.ts:14

robotIndexable#

• robotIndexable: boolean

Defined in: objects/user/full.ts:26

submissionKarma#

• submissionKarma: number

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

verifiedEmail#

• verifiedEmail: boolean

Defined in: objects/user/full.ts:24

Accessors#

key#

• get key(): string

Returns: string

Defined in: objects/user/small.ts:17

url#

• get url(): string

Returns: string

Defined in: objects/user/small.ts:31

Methods#

comments#

▸ comments(options?: GetOptions): Promise<Page<FullComment, any>>

Parameters#

Name	Type
`options?`	GetOptions

Returns: Promise<Page<FullComment, any>>

Inherited from: User

Defined in: objects/user/small.ts:116

commentsStream#

▸ commentsStream(options?: StreamOptions): AsyncIterator<FullComment, any, undefined>

Parameters#

Name	Type
`options?`	StreamOptions

Returns: AsyncIterator<FullComment, any, undefined>

Inherited from: User

Defined in: objects/user/small.ts:125

fetch#

▸ fetch(): Promise<FullUser>

Returns: Promise<FullUser>

Inherited from: User

Defined in: objects/user/small.ts:35

friend#

▸ friend(friend?: boolean, note?: string): Promise<void>

Parameters#

Name	Type	Default value
`friend`	boolean	true
`note?`	string	-

Returns: Promise<void>

Inherited from: User

Defined in: objects/user/small.ts:58

givePremium#

▸ givePremium(months: number): Promise<void>

Parameters#

Name	Type
`months`	number

Returns: Promise<void>

Inherited from: User

Defined in: objects/user/small.ts:49

is#

▸ is(u: User): boolean

Parameters#

Name	Type
`u`	User

Returns: boolean

Inherited from: User

Defined in: objects/user/small.ts:27

multis#

▸ multis(): Promise<Multi[]>

Returns: Promise<Multi[]>

Inherited from: User

Defined in: objects/user/small.ts:91

nameAvailable#

▸ nameAvailable(): Promise<boolean>

Returns: Promise<boolean>

Inherited from: User

Defined in: objects/user/small.ts:42

sendMessage#

▸ sendMessage(subject: string, body: string): Promise<void>

Parameters#

Name	Type
`subject`	string
`body`	string

Returns: Promise<void>

Inherited from: User

Defined in: objects/user/small.ts:134

submissions#

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

Parameters#

Name	Type
`options?`	GetOptions

Returns: Promise<Page<FullSubmission, any>>

Inherited from: User

Defined in: objects/user/small.ts:98

submissionsStream#

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

Parameters#

Name	Type
`options?`	StreamOptions

Returns: AsyncIterator<FullSubmission, any, undefined>

Inherited from: User

Defined in: objects/user/small.ts:107

trophies#

▸ trophies(): Promise<Trophy[]>

Returns: Promise<Trophy[]>

Inherited from: User

Defined in: objects/user/small.ts:83