Class Tags

constructor

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

  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 Tags

Static ReadonlymoduleKey

delete

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

  You must have the bd staff user flag.

  Parameters

  • id: number

  Returns Promise<null>

  Operation Id

  tags#destroy

  See

  Documentation for more details.

get

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

  Parameters

  • id: number

  Returns Promise<Tag | null>

  Operation Id

  tags#show

  See

  Documentation for more details.

preview

• preview(tags: string): Promise<TagPreview[]>
  Requires Api Key Auth

  Parameters

  • tags: string

  Returns Promise<TagPreview[]>

  Operation Id

  tags#preview

  See

  Documentation for more details.

search

• search(options?: SearchTagsOptions): Promise<Tag[]>

  Parameters

  • Optionaloptions: SearchTagsOptions

  Returns Promise<Tag[]>

  Operation Id

  tags#index

  See

  Documentation for more details.

update

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

  Must be Admin+ if the tag is locked or post count is >100.

  Parameters

  • id: number
  • options: UpdateTagOptions

  Returns Promise<null>

  Operation Id

  tags#update

  See

  Documentation for more details.