Class: WikiPage

Table of contents

Constructors

• constructor

Accessors

• content
• name
• revisionAuthor
• revisionDate
• revisionId
• revisionReason
• subredditName

Methods

• addEditor
• getRevisions
• getSettings
• removeEditor
• revertTo
• toJSON
• update
• updateSettings
• addEditor
• createPage
• getPage
• getPageRevisions
• getPageSettings
• getPages
• removeEditor
• revertPage
• updatePage
• updatePageSettings

Constructors

constructor

• new WikiPage(name, subredditName, data, metadata)

Parameters

Name	Type
name	string
subredditName	string
data	WikiPage
metadata	undefined | Metadata

Accessors

content

• get content(): string

The Markdown content of the page.

Returns

string

---

name

• get name(): string

The name of the page.

Returns

string

---

revisionAuthor

• get revisionAuthor(): User

The author of this revision.

Returns

User

---

revisionDate

• get revisionDate(): Date

The date of the revision.

Returns

Date

---

revisionId

• get revisionId(): string

The ID of the revision.

Returns

string

---

revisionReason

• get revisionReason(): string

The reason for the revision.

Returns

string

---

subredditName

• get subredditName(): string

The name of the subreddit the page is in.

Returns

string

Methods

addEditor

▸ addEditor(username): Promise<void>

Add an editor to this page.

Parameters

Name	Type
username	string

Returns

Promise<void>

---

getRevisions

▸ getRevisions(options): Promise<Listing<WikiPageRevision>>

Get the revisions for this page.

Parameters

Name	Type
options	Omit<GetPageRevisionsOptions, "page" | "subredditName">

Returns

Promise<Listing<WikiPageRevision>>

---

getSettings

▸ getSettings(): Promise<WikiPageSettings>

Get the settings for this page.

Returns

Promise<WikiPageSettings>

---

removeEditor

▸ removeEditor(username): Promise<void>

Remove an editor from this page.

Parameters

Name	Type
username	string

Returns

Promise<void>

---

revertTo

▸ revertTo(revisionId): Promise<void>

Revert this page to a previous revision.

Parameters

Name	Type
revisionId	string

Returns

Promise<void>

---

toJSON

▸ toJSON(): Object

Returns

Object

Name	Type
content	string
name	string
revisionAuthor	{ commentKarma: number ; createdAt: Date ; id: `t2_${string}` ; linkKarma: number ; modPermissionsBySubreddit: { [k: string]: T; } ; nsfw: boolean ; username: string }
revisionAuthor.commentKarma	number
revisionAuthor.createdAt	Date
revisionAuthor.id	`t2_${string}`
revisionAuthor.linkKarma	number
revisionAuthor.modPermissionsBySubreddit	{ [k: string]: T; }
revisionAuthor.nsfw	boolean
revisionAuthor.username	string
revisionDate	Date
revisionId	string
revisionReason	string
subredditName	string

---

update

▸ update(content, reason?): Promise<WikiPage>

Update this page.

Parameters

Name	Type
content	string
reason?	string

Returns

Promise<WikiPage>

---

updateSettings

▸ updateSettings(options): Promise<WikiPageSettings>

Update the settings for this page.

Parameters

Name	Type
options	Omit<UpdatePageSettingsOptions, "page" | "subredditName">

Returns

Promise<WikiPageSettings>

---

addEditor

▸ Static addEditor(subredditName, page, username, metadata): Promise<void>

Parameters

Name	Type
subredditName	string
page	string
username	string
metadata	undefined | Metadata

Returns

Promise<void>

---

createPage

▸ Static createPage(options, metadata): Promise<WikiPage>

Parameters

Name	Type
options	CreateWikiPageOptions
metadata	undefined | Metadata

Returns

Promise<WikiPage>

---

getPage

▸ Static getPage(subredditName, page, metadata): Promise<WikiPage>

Parameters

Name	Type
subredditName	string
page	string
metadata	undefined | Metadata

Returns

Promise<WikiPage>

---

getPageRevisions

▸ Static getPageRevisions(options, metadata): Listing<WikiPageRevision>

Parameters

Name	Type
options	GetPageRevisionsOptions
metadata	undefined | Metadata

Returns

Listing<WikiPageRevision>

---

getPageSettings

▸ Static getPageSettings(subredditName, page, metadata): Promise<WikiPageSettings>

Parameters

Name	Type
subredditName	string
page	string
metadata	undefined | Metadata

Returns

Promise<WikiPageSettings>

---

getPages

▸ Static getPages(subredditName, metadata): Promise<string[]>

Parameters

Name	Type
subredditName	string
metadata	undefined | Metadata

Returns

Promise<string[]>

---

removeEditor

▸ Static removeEditor(subredditName, page, username, metadata): Promise<void>

Parameters

Name	Type
subredditName	string
page	string
username	string
metadata	undefined | Metadata

Returns

Promise<void>

---

revertPage

▸ Static revertPage(subredditName, page, revisionId, metadata): Promise<void>

Parameters

Name	Type
subredditName	string
page	string
revisionId	string
metadata	undefined | Metadata

Returns

Promise<void>

---

updatePage

▸ Static updatePage(options, metadata): Promise<WikiPage>

Parameters

Name	Type
options	UpdateWikiPageOptions
metadata	undefined | Metadata

Returns

Promise<WikiPage>

---

updatePageSettings

▸ Static updatePageSettings(options, metadata): Promise<WikiPageSettings>

Parameters

Name	Type
options	UpdatePageSettingsOptions
metadata	undefined | Metadata

Returns

Promise<WikiPageSettings>