Constructor

# new Category(data)

Parameters:

Name	Type	Description
`data`	`object`

View Source classes/category.ts, line 11

Classes

Category

Methods

# static fromDatabase(data, ctx) → {Category}

Parameters:

Name	Type	Description
`data`	`DBCategory`
`ctx`	`RequestContext`

View Source classes/category.ts, line 158

Returns:

Type: Category

# async static getCategories(ctx, max, page, clientnullable) → {Promise.<Collection.<SnowflakeString, Category>>}

Gets categories

Parameters:

Name	Type	Attributes
`ctx`	`RequestContext`
`max`	`number`
`page`	`number`
`client`	`UserClient`	<nullable>

View Source classes/category.ts, line 187

Returns:

Type: Promise.<Collection.<SnowflakeString, Category>>

# async static getCategory(id, ctx, client) → {Promise.<Category>}

Fetches category by id

Parameters:

Name	Type	Description
`id`	`bigint` \| `Snowflake` \| `SnowflakeString`
`ctx`	`requestContext`
`client`	`UserClient` \| `undefined`

View Source classes/category.ts, line 168

Returns:

Type: Promise.<Category>

# async static getCategoryCount(ctx) → {Promise.<number>}

Gets total number of categories

Parameters:

Name	Type	Description
`ctx`	`RequestContext`

View Source classes/category.ts, line 176

Returns:

Type: Promise.<number>

# toJSON() → {Object}

Creates a JSON-compatible object

View Source classes/category.ts, line 200

Returns:

Type: Object

# async update() → {Promise.<void>}

Updates the given category

View Source classes/category.ts, line 194

Returns:

Type: Promise.<void>

Animasher docs

# new Category(data)

Parameters:

Classes

Methods

# static fromDatabase(data, ctx) → {Category}

Parameters:

# async static getCategories(ctx, max, page, clientnullable) → {Promise.<Collection.<SnowflakeString, Category>>}

Parameters:

# async static getCategory(id, ctx, client) → {Promise.<Category>}

Parameters:

# async static getCategoryCount(ctx) → {Promise.<number>}

Parameters:

# toJSON() → {Object}

# async update() → {Promise.<void>}