Class Tag

Schema

See

Documentation for more details.

Hierarchy (View Summary)

Tag
Base<TagData>
- Tag

Index

Constructors

Methods

[custom] delete getCorrection preview toJSON update

Constructors

constructor

new Tag(e621: E621, data: Tag): Tag
Parameters
- e621: E621
- data: Tag
Returns Tag
Inherited from Base.constructor
- Defined in lib/models/Base.ts:10

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:18

delete

delete(): Promise<null>
Requires Api Key Auth
Delete Tag

You must have the bd staff user flag.

Returns Promise<null>

Operation Id
tags#destroy

See
Documentation for more details.
- Defined in lib/models/Tag.ts:32

getCorrection

getCorrection(): Promise<TagCorrection>
Get Tag Correction

Returns Promise<TagCorrection>

Operation Id
tag_corrections#show

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

preview

preview(): Promise<TagPreview[]>
Requires Api Key Auth
Preview Tags

Returns Promise<TagPreview[]>

Operation Id
tags#preview

See
Documentation for more details.
- Defined in lib/models/Tag.ts:58

toJSON

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

update

update(options: UpdateTagOptions): Promise<null>
Requires Api Key Auth
Update Tag

Must be Admin+ if the tag is locked or post count is >100.
Parameters
- options: UpdateTagOptions
Returns Promise<null>

Operation Id
tags#update

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