Class Tag

This class represents a genre tag for a manga

Hierarchy (View Summary)

IDObject
- Tag

Implements

TagAttributesSchema

Index

Constructors

Properties

description group id name version

Accessors

localDescription localName

Methods

getAllTags getByName getByNames

Constructors

constructor

new Tag(data: TagSchema): Tag
Parameters
- data: TagSchema
Returns Tag
Overrides IDObject.constructor
- Defined in src/shared/Tag.ts:33

Properties

description

description: LocalizedString

Localized descriptions for this tag

group

group: "content" | "format" | "genre" | "theme"

The tag group this tag belongs to

id

id: string

MangaDex UUID of this tag

name

name: LocalizedString

Localized names for this tag

version

version: number

The version of this tag (incremented whenever the tag's data is updated)

Accessors

localDescription

get localDescription(): string
Get the localString from the description LocalizedString object

Returns string
- Defined in src/shared/Tag.ts:52

localName

get localName(): string
Get the localString from the name LocalizedString object

Returns string
- Defined in src/shared/Tag.ts:45

Methods

`Static`getAllTags

getAllTags(): Promise<Tag[]>
Retrieves every tag used on MangaDex. The result is cached so any promise after the first will resolve instantly.

Returns Promise<Tag[]>
- Defined in src/shared/Tag.ts:60

`Static`getByName

getByName(name: string): Promise<Tag>
Return the first tag that contains the specified name
Parameters
- name: string
Returns Promise<Tag>
- Defined in src/shared/Tag.ts:71

`Static`getByNames

getByNames(names: string[]): Promise<Tag[]>
Return tags with the associated names
Parameters
- names: string[]
Returns Promise<Tag[]>
- Defined in src/shared/Tag.ts:82