Class TagAliases

Hierarchy (View Summary)

Base
- TagAliases

Index

Constructors

Methods

approve create edit get reject search

Constructors

constructor

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

Methods

approve

approve(id: number): Promise<null>
Requires Api Key Auth
Approve Tag Alias

You must be Admin+.
Parameters
- id: number
Returns Promise<null>
Operation Id
approveTagAlias

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

create

create(options: CreateTagAliasOptions): Promise<unknown>
Requires Api Key Auth
Create Tag Alias

Errors will result in a 406 with no information.
Parameters
- options: CreateTagAliasOptions
Returns Promise<unknown>
Operation Id
createTagAlias

See
Documentation for more details.
- Defined in lib/modules/TagAliases.ts:54

edit

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

You must be Admin+.
Parameters
- id: number
- options: EditTagAliasOptions
Returns Promise<null>
Operation Id
editTagAlias

See
Documentation for more details.
- Defined in lib/modules/TagAliases.ts:73

get

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

See
Documentation for more details.
- Defined in lib/modules/TagAliases.ts:89

reject

reject(id: number): Promise<null>
Requires Api Key Auth
Reject Tag Alias

You must be the creator of the request (if pending), or Admin+.
Parameters
- id: number
Returns Promise<null>
Operation Id
rejectTagAlias

See
Documentation for more details.
- Defined in lib/modules/TagAliases.ts:108

search

search(options?: SearchTagAliasesOptions): Promise<TagAlias[]>
Search Tag Aliases
Parameters
- Optionaloptions: SearchTagAliasesOptions
Returns Promise<TagAlias[]>
Operation Id
searchTagAliases

See
Documentation for more details.
- Defined in lib/modules/TagAliases.ts:123