Class: WikiPage
models.WikiPage
Table of contents
Accessors
Methods
Accessors
content
• get content(): string
The Markdown content of the page.
Returns
string
contentHtml
• get contentHtml(): string
The HTML content of the page.
Returns
string
name
• get name(): string
The name of the page.
Returns
string
revisionAuthor
• get revisionAuthor(): undefined | User
The author of this revision.
Returns
undefined | 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, "subredditName" | "page"> |
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(): Pick<WikiPage, "subredditName" | "name" | "content" | "contentHtml" | "revisionId" | "revisionDate" | "revisionReason"> & { revisionAuthor: undefined | Pick<User, "username" | "id" | "nsfw" | "createdAt" | "linkKarma" | "commentKarma"> & { modPermissionsBySubreddit: Record<string, ModeratorPermission[]> } }
Returns
Pick<WikiPage, "subredditName" | "name" | "content" | "contentHtml" | "revisionId" | "revisionDate" | "revisionReason"> & { revisionAuthor: undefined | Pick<User, "username" | "id" | "nsfw" | "createdAt" | "linkKarma" | "commentKarma"> & { modPermissionsBySubreddit: Record<string, ModeratorPermission[]> } }
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, "subredditName" | "page"> |
Returns
Promise<WikiPageSettings>