Class Artists

constructor

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

  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 Artists

Static ReadonlymoduleKey

create

• create(options: CreateArtistOptions): Promise<Artist>
  Requires Api Key Auth

  other_names & urls are silently truncated to 25 entries. notes is silently truncated to the wiki page limit (250,000). Individual other_names are silently truncated to 100 characters.

  Parameters

  • options: CreateArtistOptions

  Returns Promise<Artist>

  Operation Id

  artists#create

  See

  Documentation for more details.

delete

• delete(idOrName: string | number): Promise<null>
  Requires Api Key Auth

  You must be an Admin+ to delete an artist.

  Parameters

  • idOrName: string | number

  Returns Promise<null>

  Operation Id

  artists#destroy

  See

  Documentation for more details.

get

• get(idOrName: string | number): Promise<Artist | null>

  Parameters

  • idOrName: string | number

  Returns Promise<Artist | null>

  Operation Id

  artists#show

  See

  Documentation for more details.

revert

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

  If an artist is locked, you must be Staff+ to revert them.

  Parameters

  • idOrName: string | number
  • version_id: number

  Returns Promise<null>

  Operation Id

  artists#revert

  See

  Documentation for more details.

search

• search(options?: SearchArtistsOptions): Promise<Artist[]>

  Parameters

  • Optionaloptions: SearchArtistsOptions

  Returns Promise<Artist[]>

  Operation Id

  artists#index

  See

  Documentation for more details.

update

• update(idOrName: string | number, options: UpdateArtistOptions): Promise<null>
  Requires Api Key Auth

  If an artist is locked, you must be Staff+ to edit them. other_names & urls are silently truncated to 25 entries. notes is silently truncated to the wiki page limit (250,000). Individual other_names are silently truncated to 100 characters. If an artist is on the avoid posting list, you must have the bd staff user flag to edit name, other_names, or group_name.

  Parameters

  • idOrName: string | number
  • options: UpdateArtistOptions

  Returns Promise<null>

  Operation Id

  artists#update

  See

  Documentation for more details.