Class: Post

Table of contents

Constructors

• constructor

Accessors

• approved
• archived
• authorId
• authorName
• body
• comments
• createdAt
• distinguishedBy
• edited
• hidden
• id
• ignoringReports
• locked
• nsfw
• numberOfComments
• numberOfReports
• permalink
• quarantined
• removed
• score
• spam
• spoiler
• stickied
• subredditId
• subredditName
• thumbnail
• title
• url

Methods

• addComment
• approve
• crosspost
• delete
• distinguish
• distinguishAsAdmin
• edit
• getAuthor
• hide
• ignoreReports
• isApproved
• isArchived
• isDistinguishedBy
• isEdited
• isHidden
• isIgnoringReports
• isLocked
• isNsfw
• isQuarantined
• isRemoved
• isSpam
• isSpoiler
• isStickied
• lock
• markAsNsfw
• markAsSpoiler
• remove
• sticky
• toJSON
• undistinguish
• unhide
• unignoreReports
• unlock
• unmarkAsNsfw
• unmarkAsSpoiler
• unsticky
• approve
• crosspost
• delete
• distinguish
• edit
• getById
• getControversialPosts
• getHotPosts
• getNewPosts
• getPostsByUser
• getRisingPosts
• getSortedPosts
• getTopPosts
• hide
• ignoreReports
• lock
• markAsNsfw
• markAsSpoiler
• remove
• sticky
• submit
• undistinguish
• unhide
• unignoreReports
• unlock
• unmarkAsNsfw
• unmarkAsSpoiler
• unsticky

Constructors

constructor

• new Post(data, metadata?)

Parameters

Name	Type
data	RedditObject
metadata?	Metadata

Accessors

approved

• get approved(): boolean

Returns

boolean

---

archived

• get archived(): boolean

Returns

boolean

---

authorId

• get authorId(): `t2_${string}`

Returns

`t2_${string}`

---

authorName

• get authorName(): string

Returns

string

---

body

• get body(): undefined | string

Returns

undefined | string

---

comments

• get comments(): Listing< Comment>

Returns

Listing< Comment>

---

createdAt

• get createdAt(): Date

Returns

Date

---

distinguishedBy

• get distinguishedBy(): undefined | string

Returns

undefined | string

---

edited

• get edited(): boolean

Returns

boolean

---

hidden

• get hidden(): boolean

Returns

boolean

---

id

• get id(): `t3_${string}`

Returns

`t3_${string}`

---

ignoringReports

• get ignoringReports(): boolean

Returns

boolean

---

locked

• get locked(): boolean

Returns

boolean

---

nsfw

• get nsfw(): boolean

Returns

boolean

---

numberOfComments

• get numberOfComments(): number

Returns

number

---

numberOfReports

• get numberOfReports(): number

Returns

number

---

permalink

• get permalink(): string

Returns

string

---

quarantined

• get quarantined(): boolean

Returns

boolean

---

removed

• get removed(): boolean

Returns

boolean

---

score

• get score(): number

Returns

number

---

spam

• get spam(): boolean

Returns

boolean

---

spoiler

• get spoiler(): boolean

Returns

boolean

---

stickied

• get stickied(): boolean

Returns

boolean

---

subredditId

• get subredditId(): `t5_${string}`

Returns

`t5_${string}`

---

subredditName

• get subredditName(): string

Returns

string

---

thumbnail

• get thumbnail(): undefined | { height: number ; url: string ; width: number }

Returns

undefined | { height: number ; url: string ; width: number }

---

title

• get title(): string

Returns

string

---

url

• get url(): string

Returns

string

Methods

addComment

▸ addComment(options): Promise< Comment>

Parameters

Name	Type
options	CommentSubmissionOptions

Returns

Promise< Comment>

---

approve

▸ approve(): Promise< void>

Returns

Promise< void>

---

crosspost

▸ crosspost(options): Promise< Post>

Parameters

Name	Type
options	Omit< CrosspostOptions, "postId">

Returns

Promise< Post>

---

delete

▸ delete(): Promise< void>

Returns

Promise< void>

---

distinguish

▸ distinguish(): Promise< void>

Returns

Promise< void>

---

distinguishAsAdmin

▸ distinguishAsAdmin(): Promise< void>

Returns

Promise< void>

---

edit

▸ edit(options): Promise< void>

Parameters

Name	Type
options	PostTextOptions

Returns

Promise< void>

---

getAuthor

▸ getAuthor(): Promise< User>

Returns

Promise< User>

---

hide

▸ hide(): Promise< void>

Returns

Promise< void>

---

ignoreReports

▸ ignoreReports(): Promise< void>

Returns

Promise< void>

---

isApproved

▸ isApproved(): boolean

Returns

boolean

---

isArchived

▸ isArchived(): boolean

Returns

boolean

---

isDistinguishedBy

▸ isDistinguishedBy(): undefined | string

Returns

undefined | string

---

isEdited

▸ isEdited(): boolean

Returns

boolean

---

isHidden

▸ isHidden(): boolean

Returns

boolean

---

isIgnoringReports

▸ isIgnoringReports(): boolean

Returns

boolean

---

isLocked

▸ isLocked(): boolean

Returns

boolean

---

isNsfw

▸ isNsfw(): boolean

Returns

boolean

---

isQuarantined

▸ isQuarantined(): boolean

Returns

boolean

---

isRemoved

▸ isRemoved(): boolean

Returns

boolean

---

isSpam

▸ isSpam(): boolean

Returns

boolean

---

isSpoiler

▸ isSpoiler(): boolean

Returns

boolean

---

isStickied

▸ isStickied(): boolean

Returns

boolean

---

lock

▸ lock(): Promise< void>

Returns

Promise< void>

---

markAsNsfw

▸ markAsNsfw(): Promise< void>

Returns

Promise< void>

---

markAsSpoiler

▸ markAsSpoiler(): Promise< void>

Returns

Promise< void>

---

remove

▸ remove(isSpam?): Promise< void>

Parameters

Name	Type	Default value
isSpam	boolean	false

Returns

Promise< void>

---

sticky

▸ sticky(position?): Promise< void>

Parameters

Name	Type
position?	2 | 1 | 3 | 4

Returns

Promise< void>

---

toJSON

▸ toJSON(): Object

Returns

Object

Name	Type
approved	boolean
archived	boolean
authorId	`t2_${string}`
authorName	string
body	undefined | string
createdAt	Date
distinguishedBy	undefined | string
edited	boolean
hidden	boolean
id	`t3_${string}`
ignoringReports	boolean
locked	boolean
nsfw	boolean
numberOfComments	number
numberOfReports	number
permalink	string
quarantined	boolean
removed	boolean
score	number
spam	boolean
spoiler	boolean
stickied	boolean
subredditId	`t5_${string}`
subredditName	string
thumbnail	undefined | { height: number ; url: string ; width: number }
title	string
url	string

---

undistinguish

▸ undistinguish(): Promise< void>

Returns

Promise< void>

---

unhide

▸ unhide(): Promise< void>

Returns

Promise< void>

---

unignoreReports

▸ unignoreReports(): Promise< void>

Returns

Promise< void>

---

unlock

▸ unlock(): Promise< void>

Returns

Promise< void>

---

unmarkAsNsfw

▸ unmarkAsNsfw(): Promise< void>

Returns

Promise< void>

---

unmarkAsSpoiler

▸ unmarkAsSpoiler(): Promise< void>

Returns

Promise< void>

---

unsticky

▸ unsticky(): Promise< void>

Returns

Promise< void>

---

approve

▸ Static approve(id, metadata?): Promise< void>

Parameters

Name	Type
id	`t3_${string}`
metadata?	Metadata

Returns

Promise< void>

---

crosspost

▸ Static crosspost(options, metadata?): Promise< Post>

Parameters

Name	Type
options	CrosspostOptions
metadata?	Metadata

Returns

Promise< Post>

---

delete

▸ Static delete(id, metadata?): Promise< void>

Parameters

Name	Type
id	`t3_${string}`
metadata?	Metadata

Returns

Promise< void>

---

distinguish

▸ Static distinguish(id, asAdmin, metadata?): Promise< { distinguishedBy: undefined | string = post.distinguished }>

Parameters

Name	Type
id	`t3_${string}`
asAdmin	boolean
metadata?	Metadata

Returns

Promise< { distinguishedBy: undefined | string = post.distinguished }>

---

edit

▸ Static edit(options, metadata?): Promise< Post>

Parameters

Name	Type
options	Object
metadata?	Metadata

Returns

Promise< Post>

---

getById

▸ Static getById(id, metadata?): Promise< Post>

Parameters

Name	Type
id	`t3_${string}`
metadata?	Metadata

Returns

Promise< Post>

---

getControversialPosts

▸ Static getControversialPosts(options?, metadata?): Listing< Post>

Parameters

Name	Type
options	GetPostsOptionsWithTimeframe
metadata?	Metadata

Returns

Listing< Post>

---

getHotPosts

▸ Static getHotPosts(options?, metadata?): Listing< Post>

Parameters

Name	Type
options	GetHotPostsOptions
metadata?	Metadata

Returns

Listing< Post>

---

getNewPosts

▸ Static getNewPosts(options, metadata?): Listing< Post>

Parameters

Name	Type
options	GetPostsOptions
metadata?	Metadata

Returns

Listing< Post>

---

getPostsByUser

▸ Static getPostsByUser(options, metadata?): Listing< Post>

Parameters

Name	Type
options	GetPostsByUserOptions
metadata?	Metadata

Returns

Listing< Post>

---

getRisingPosts

▸ Static getRisingPosts(options, metadata?): Listing< Post>

Parameters

Name	Type
options	GetPostsOptions
metadata?	Metadata

Returns

Listing< Post>

---

getSortedPosts

▸ Static getSortedPosts(options, metadata?): Listing< Post>

Parameters

Name	Type
options	GetSortedPostsOptions
metadata?	Metadata

Returns

Listing< Post>

---

getTopPosts

▸ Static getTopPosts(options?, metadata?): Listing< Post>

Parameters

Name	Type
options	GetPostsOptionsWithTimeframe
metadata?	Metadata

Returns

Listing< Post>

---

hide

▸ Static hide(id, metadata?): Promise< void>

Parameters

Name	Type
id	`t3_${string}`
metadata?	Metadata

Returns

Promise< void>

---

ignoreReports

▸ Static ignoreReports(id, metadata?): Promise< void>

Parameters

Name	Type
id	`t3_${string}`
metadata?	Metadata

Returns

Promise< void>

---

lock

▸ Static lock(id, metadata?): Promise< void>

Parameters

Name	Type
id	`t3_${string}`
metadata?	Metadata

Returns

Promise< void>

---

markAsNsfw

▸ Static markAsNsfw(id, metadata?): Promise< void>

Parameters

Name	Type
id	`t3_${string}`
metadata?	Metadata

Returns

Promise< void>

---

markAsSpoiler

▸ Static markAsSpoiler(id, metadata?): Promise< void>

Parameters

Name	Type
id	`t3_${string}`
metadata?	Metadata

Returns

Promise< void>

---

remove

▸ Static remove(id, isSpam?, metadata?): Promise< void>

Parameters

Name	Type	Default value
id	`t3_${string}`	undefined
isSpam	boolean	false
metadata?	Metadata	undefined

Returns

Promise< void>

---

sticky

▸ Static sticky(id, position?, metadata?): Promise< void>

Parameters

Name	Type
id	`t3_${string}`
position?	2 | 1 | 3 | 4
metadata?	Metadata

Returns

Promise< void>

---

submit

▸ Static submit(options, metadata?): Promise< Post>

Parameters

Name	Type
options	SubmitPostOptions
metadata?	Metadata

Returns

Promise< Post>

---

undistinguish

▸ Static undistinguish(id, metadata?): Promise< { distinguishedBy: undefined | string = post.distinguished }>

Parameters

Name	Type
id	`t3_${string}`
metadata?	Metadata

Returns

Promise< { distinguishedBy: undefined | string = post.distinguished }>

---

unhide

▸ Static unhide(id, metadata?): Promise< void>

Parameters

Name	Type
id	`t3_${string}`
metadata?	Metadata

Returns

Promise< void>

---

unignoreReports

▸ Static unignoreReports(id, metadata?): Promise< void>

Parameters

Name	Type
id	`t3_${string}`
metadata?	Metadata

Returns

Promise< void>

---

unlock

▸ Static unlock(id, metadata?): Promise< void>

Parameters

Name	Type
id	`t3_${string}`
metadata?	Metadata

Returns

Promise< void>

---

unmarkAsNsfw

▸ Static unmarkAsNsfw(id, metadata?): Promise< void>

Parameters

Name	Type
id	`t3_${string}`
metadata?	Metadata

Returns

Promise< void>

---

unmarkAsSpoiler

▸ Static unmarkAsSpoiler(id, metadata?): Promise< void>

Parameters

Name	Type
id	`t3_${string}`
metadata?	Metadata

Returns

Promise< void>

---

unsticky

▸ Static unsticky(id, metadata?): Promise< void>

Parameters

Name	Type
id	`t3_${string}`
metadata?	Metadata

Returns

Promise< void>