Class Users

constructor

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

  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 Users

Static ReadonlymoduleKey

avatarMenu

• avatarMenu(): Promise<UsersAvatarMenuResponse>
  Requires Api Key Auth

  Returns Promise<UsersAvatarMenuResponse>

  Operation Id

  users#avatar_menu

  See

  Documentation for more details.

clearFavorites

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

  You must be Admin+.

  Parameters

  • idOrName: string | number

  Returns Promise<string>

  Operation Id

  users#flush_favorites

  See

  Documentation for more details.

customStyle

• customStyle(): Promise<string>
  Requires Api Key Auth

  Returns Promise<string>

  Operation Id

  users#custom_style

  See

  Documentation for more details.

disableKarmaFree

• disableKarmaFree(
      idOrName: string | number,
      options?: DisableUserKarmaFreeOptions,
  ): Promise<string>
  Requires Api Key Auth

  You must be Janitor+.

  Parameters

  • idOrName: string | number
  • Optionaloptions: DisableUserKarmaFreeOptions

  Returns Promise<string>

  Operation Id

  users#disable_karma_free

  See

  Documentation for more details.

disableUploads

• disableUploads(
      idOrName: string | number,
      options?: DisableUserUploadsOptions,
  ): Promise<string>
  Requires Api Key Auth

  You must be Janitor+.

  Parameters

  • idOrName: string | number
  • Optionaloptions: DisableUserUploadsOptions

  Returns Promise<string>

  Operation Id

  users#disable_uploads

  See

  Documentation for more details.

fixCounts

• fixCounts(): Promise<string>
  Requires Api Key Auth

  Returns Promise<string>

  Operation Id

  maintenance/user/count_fixes#create

  See

  Documentation for more details.

get

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

  Parameters

  • idOrName: string | number

  Returns Promise<FullCurrentUser | FullUser | null>

  Operation Id

  users#show

  See

  Documentation for more details.

me

• me(): Promise<FullCurrentUser>

  This will return the default settings for anonymous users if no authentication is used. This most interesting part is probably the default blacklist, located in blacklisted_tags.

  Returns Promise<FullCurrentUser>

  Operation Id

  users#me

  See

  Documentation for more details.

search

• search(options?: SearchUsersOptions): Promise<(User<User> | FullCurrentUser)[]>

  Parameters

  • Optionaloptions: SearchUsersOptions

  Returns Promise<(User<User> | FullCurrentUser)[]>

  Operation Id

  users#index

  See

  Documentation for more details.

staffFixCounts

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

  You must be Janitor+.

  Parameters

  • idOrName: string | number

  Returns Promise<string>

  Operation Id

  users#fix_counts

  See

  Documentation for more details.

toggleKarmaFree

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

  You must be Janitor+.

  Parameters

  • idOrName: string | number

  Returns Promise<string>

  Operation Id

  users#toggle_karma_free

  See

  Documentation for more details.

toggleUploads

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

  You must be Janitor+. This endpoint will return HTML when disabling uploads (due to a reason being required), this endpoint should only be used for reenabling. Use Disable User Uploads to disable uploads.

  Parameters

  • idOrName: string | number

  Returns Promise<string>

  Operation Id

  users#toggle_uploads

  See

  Documentation for more details.

update

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

  Parameters

  • idOrName: string | number
  • options: UpdateCurrentUserOptions

  Returns Promise<null>

  Operation Id

  users#update

  See

  Documentation for more details.

updateAvatarCrop

• updateAvatarCrop(options: UpdateAvatarCropOptions): Promise<string>
  Requires Api Key Auth

  Parameters

  • options: UpdateAvatarCropOptions

  Returns Promise<string>

  Operation Id

  maintenance/user/avatars#update

  See

  Documentation for more details.

updateDmailFilter

• updateDmailFilter(dmail_id: number, words: string): Promise<null>
  Requires Api Key Auth

  Parameters

  • dmail_id: number
  • words: string

  Returns Promise<null>

  Operation Id

  maintenance/user/dmail_filters#update

  See

  Documentation for more details.

uploadLimit

• uploadLimit(
      idOrName: string | number,
  ): Promise<FullCurrentUser | FullUser | null>
  Requires Api Key Auth

  Parameters

  • idOrName: string | number

  Returns Promise<FullCurrentUser | FullUser | null>

  Operation Id

  users#upload_limit

  See

  Documentation for more details.

uploadTags

• uploadTags(): Promise<UsersUploadTagsResponse>
  Requires Api Key Auth

  Returns the current user's favorite tags and recently used tags, for use in the upload tag editor.

  Returns Promise<UsersUploadTagsResponse>

  Operation Id

  users#upload_tags

  See

  Documentation for more details.