Class CurrentUser<D>

constructor

• new CurrentUser<D extends CurrentUser = CurrentUser>(
      e621: E621<NoV2Options>,
      data: D,
  ): CurrentUser<D>

  Type Parameters

  • D extends CurrentUser = CurrentUser

  Parameters

  • e621: E621<NoV2Options>
  • data: D

  Returns CurrentUser<D>

last_logged_in_at

[custom]

• "[custom]"(_depth: never, opts: InspectOptions): string

  Parameters

  • _depth: never
  • opts: InspectOptions

  Returns string

adminEdit

• adminEdit(options: UpdateStaffUserOptions): Promise<null>
  Requires Api Key Auth

  You must be Admin+. If editing an Admin+, you must be Owner+.

  Parameters

  • options: UpdateStaffUserOptions

  Returns Promise<null>

  Operation Id

  staff/users#update

  See

  Documentation for more details.

anonymize

• anonymize(): Promise<unknown>
  Requires Api Key Auth

  You must have the bd staff user flag. Cannot be used on staff.

  Returns Promise<unknown>

  Operation Id

  staff/users#anonymize_confirm

  See

  Documentation for more details.

avatarMenu

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

  Returns Promise<UsersAvatarMenuResponse>

  Operation Id

  users#avatar_menu

  See

  Documentation for more details.

clearFavorites

• clearFavorites(): Promise<unknown>
  Requires Api Key Auth

  You must be Admin+.

  Returns Promise<unknown>

  Operation Id

  users#flush_favorites

  See

  Documentation for more details.

disableUploads

• disableUploads(reason?: string): Promise<string>
  Requires Api Key Auth

  You must be Janitor+.

  Parameters

  • Optionalreason: string

  Returns Promise<string>

  Operation Id

  users#disable_uploads

  See

  Documentation for more details.

fixCounts

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

  Returns Promise<unknown>

  Operation Id

  maintenance/user/count_fixes#create

  See

  Documentation for more details.

staffFixCounts

• staffFixCounts(): Promise<unknown>
  Requires Api Key Auth

  You must be Janitor+.

  Returns Promise<unknown>

  Operation Id

  users#fix_counts

  See

  Documentation for more details.

toggleUploads

• toggleUploads(): 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.

  Returns Promise<string>

  Operation Id

  users#toggle_uploads

  See

  Documentation for more details.

toJSON

• toJSON(): D

  Returns D

update

• update(options: UpdateCurrentUserOptions): Promise<null>
  Requires Api Key Auth

  Parameters

  • 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.

uploadLimit

• uploadLimit(): Promise<User<User>>
  Requires Api Key Auth

  Returns Promise<User<User>>

  Operation Id

  users#upload_limit

  See

  Documentation for more details.