Class Tag

Schema

See

Documentation for more details.

Hierarchy (View Summary)

Tag
Base<TagData>
- Tag

Index

Constructors

Methods

[custom] delete edit getCorrection preview toJSON

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

delete

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

You must have the bd staff user flag.

Returns Promise<null>
Operation Id
deleteTag

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

edit

edit(options: EditTagOptions): Promise<null>
Requires Api Key Auth
Edit Tag

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

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

getCorrection

getCorrection(): Promise<TagCorrection>
Get Tag Correction

Returns Promise<TagCorrection>
Operation Id
getTagCorrection

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

preview

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

Returns Promise<TagPreview[]>
Operation Id
previewTags

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

toJSON

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