Class Tags

Hierarchy (View Summary)

Base
- Tags

Index

Constructors

Methods

delete get preview search update

Constructors

constructor

new Tags(e621: E621, client: Client): Tags
Parameters
- e621: E621
- client: Client
Returns Tags
Inherited from Base.constructor
- Defined in lib/modules/Base.ts:20

Methods

delete

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

You must have the bd staff user flag.
Parameters
- id: number
Returns Promise<null>

Operation Id
tags#destroy

See
Documentation for more details.
- Defined in lib/modules/Tags.ts:35

get

get(id: number): Promise<Tag | null>
Get Tag
Parameters
- id: number
Returns Promise<Tag | null>

Operation Id
tags#show

See
Documentation for more details.
- Defined in lib/modules/Tags.ts:50

preview

preview(tags: string): Promise<TagPreview[]>
Requires Api Key Auth
Preview Tags
Parameters
- tags: string
Returns Promise<TagPreview[]>

Operation Id
tags#preview

See
Documentation for more details.
- Defined in lib/modules/Tags.ts:67

search

search(options?: SearchTagsOptions): Promise<Tag[]>
Tags Index
Parameters
- Optionaloptions: SearchTagsOptions
Returns Promise<Tag[]>

Operation Id
tags#index

See
Documentation for more details.
- Defined in lib/modules/Tags.ts:82

update

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

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

Operation Id
tags#update

See
Documentation for more details.
- Defined in lib/modules/Tags.ts:101