Class WikiPages

constructor

• new WikiPages(e621: E621<NoV2Options> | undefined, client: Client): WikiPages

  e621 may be omitted (pass undefined) when constructing a module standalone, without the main E621 client, to keep bundles tree-shakable. Convenience methods on models returned by this module that call back into other modules via this.e621 will throw in that case.

  Parameters

  • e621: E621<NoV2Options> | undefined
  • client: Client

  Returns WikiPages

Static ReadonlymoduleKey

create

• create(options: CreateWikiPageOptions): Promise<WikiPage>
  Requires Api Key Auth

  Parameters

  • options: CreateWikiPageOptions

  Returns Promise<WikiPage>

  Operation Id

  wiki_pages#create

  See

  Documentation for more details.

delete

• delete(id: number): Promise<null>
  Requires Api Key Auth

  You must be Admin+

  Parameters

  • id: number

  Returns Promise<null>

  Operation Id

  wiki_pages#destroy

  See

  Documentation for more details.

get

• get(id: number): Promise<WikiPage | null>

  Parameters

  • id: number

  Returns Promise<WikiPage | null>

  Operation Id

  wiki_pages#show

  See

  Documentation for more details.

revert

• revert(id: number, version_id: number): Promise<null>
  Requires Api Key Auth

  Parameters

  • id: number
  • version_id: number

  Returns Promise<null>

  Operation Id

  wiki_pages#revert

  See

  Documentation for more details.

search

• search(options?: SearchWikiPagesOptions): Promise<WikiPage[]>

  Parameters

  • Optionaloptions: SearchWikiPagesOptions

  Returns Promise<WikiPage[]>

  Operation Id

  wiki_pages#index

  See

  Documentation for more details.

update

• update(id: number, options: UpdateWikiPageOptions): Promise<null>
  Requires Api Key Auth

  You must be Staff+ if the wiki page is locked.

  Parameters

  • id: number
  • options: UpdateWikiPageOptions

  Returns Promise<null>

  Operation Id

  wiki_pages#update

  See

  Documentation for more details.