Class Tags

Hierarchy (View Summary)

Base
- Tags

Index

Constructors

Methods

delete edit get preview search

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

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
deleteTag

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

edit

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

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

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

get

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

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

preview

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

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

search

search(options?: SearchTagsOptions): Promise<Tag[]>
Search Tags
Parameters
- Optionaloptions: SearchTagsOptions
Returns Promise<Tag[]>
Operation Id
searchTags

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