Class CategoryEntity

Hierarchy

BaseMongoEntity
- CategoryEntity

Implements

Category

Index

Constructors

Properties

ancestors description icon? level name parentId sequence status

Constructors

constructor

new CategoryEntity(opts): CategoryEntity
Parameters
- opts: Partial<Omit<Category, "id" | "level" | "ancestors">> & {
      name: string;
  } & {
      ancestors?: string[];
      level?: number;
  }
Returns CategoryEntity
Overrides mongo.BaseMongoEntity.constructor
- Defined in src/adapter/default/schemas/entities/category.ts:32

Properties

ancestors

ancestors: string[]

Category ancestors

description

description: string

A description of the product category.

`Optional` icon

icon?: CategoryIcon

Category Icon object

level

level: number

Category level

name

name: string

The name of the product category.

parentId

parentId: string

Parent ID of the category

sequence

sequence: number

The sequence of the category. This is useful when user want to customize the order when displaying category

status

status: "ACTIVE" | "INACTIVE"

Category status

Generated using TypeDoc