Class User<D>

Schema

See

Documentation for more details.

Type Parameters

D extends UserData = UserData

Hierarchy (View Summary)

User
Base<D>
- User
  - CurrentUser
  - FullUser

Index

Constructors

Methods

[custom] adminEdit anonymize clearFavorites fixCounts staffFixCounts toggleUploads toJSON uploadLimit

Constructors

constructor

new User<D extends User = User>(e621: E621, data: D): User<D>
Type Parameters
- D extends User = User
Parameters
- e621: E621
- data: D
Returns User<D>
Inherited from Base.constructor
- Defined in lib/models/Base.ts:9

Methods

[custom]

"[custom]"(_depth: never, opts: InspectOptions): string
Parameters
- _depth: never
- opts: InspectOptions
Returns string
Inherited from Base.[custom]
- Defined in lib/models/Base.ts:17

adminEdit

adminEdit(options: AdminEditUserOptions): Promise<null>
Requires Api Key Auth
Admin Edit User

You must be Admin+. If editing an Admin+, you must be Owner+.
Parameters
- options: AdminEditUserOptions
Returns Promise<null>
Operation Id
adminEditUser

See
Documentation for more details.
- Defined in lib/models/User.ts:28

anonymize

anonymize(): Promise<unknown>
Requires Api Key Auth
Admin Anonymize User

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

Returns Promise<unknown>
Operation Id
adminAnonymizeUser

See
Documentation for more details.
- Defined in lib/models/User.ts:44

clearFavorites

clearFavorites(): Promise<unknown>
Requires Api Key Auth
Clear User Favorites

You must be Admin+.

Returns Promise<unknown>
Operation Id
clearUserFavorites

See
Documentation for more details.
- Defined in lib/models/User.ts:60

fixCounts

fixCounts(): Promise<unknown>
Requires Api Key Auth
Fix User Counts

Returns Promise<unknown>
Operation Id
fixUserCounts

See
Documentation for more details.
- Defined in lib/models/User.ts:74

staffFixCounts

staffFixCounts(): Promise<unknown>
Requires Api Key Auth
Staff Fix User Counts

You must be Janitor+.

Returns Promise<unknown>
Operation Id
staffFixUserCounts

See
Documentation for more details.
- Defined in lib/models/User.ts:90

toggleUploads

toggleUploads(): Promise<string>
Requires Api Key Auth
Toggle User Uploads

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
toggleUserUploads

See
Documentation for more details.
- Defined in lib/models/User.ts:108

toJSON

toJSON(): D
Returns D
Inherited from Base.toJSON
- Defined in lib/models/Base.ts:39

uploadLimit

uploadLimit(): Promise<User<User>>
Requires Api Key Auth
Get User Upload Limit

Returns Promise<User<User>>
Operation Id
getUserUploadLimit

See
Documentation for more details.
- Defined in lib/models/User.ts:122