Class CategoryClient

Hierarchy

CategoryClient

Index

Constructors

constructor

Properties

client

Methods

Constructors

constructor

new CategoryClient(client: HttpClient): CategoryClient

- Defined in admin-api/src/clients/CategoryClient.ts:8
Parameters
- client: HttpClient
Returns CategoryClient

Properties

Private client

client: HttpClient

Methods

create

create(params: CategoryParam): Promise<Response<Category>>

- Defined in admin-api/src/clients/CategoryClient.ts:57
Creates a category.

Parameters
- params: CategoryParam
  
  category parameter to create
Returns Promise<Response<Category>>
A response of created category.

delete

delete(categoryId: number): Promise<void>

- Defined in admin-api/src/clients/CategoryClient.ts:95
Deletes a category by id.

Parameters
- categoryId: number
  
  category id
Returns Promise<void>

get

get(categoryId: number): Promise<Response<Category>>

- Defined in admin-api/src/clients/CategoryClient.ts:44
Gets category detail by id.

Parameters
- categoryId: number
  
  category id
Returns Promise<Response<Category>>
A response of category detail.

list

list(params: { more?: boolean; sort?: string[] }): Promise<Response<Category[]>>

- Defined in admin-api/src/clients/CategoryClient.ts:18
Lists all categories.

Parameters
- params: { more?: boolean; sort?: string[] }
  
  parameter for queries
  - Optional more?: boolean
  - Optional sort?: string[]
Returns Promise<Response<Category[]>>
A response of all categories.

listAsTree

listAsTree(sort: string[]): Promise<Response<CategoryTree[]>>

- Defined in admin-api/src/clients/CategoryClient.ts:31
List all categories as tree.

Parameters
- sort: string[]
  
  sort option for queries, value is category field
Returns Promise<Response<CategoryTree[]>>
A response of all categories.

update

update(categoryId: number, params: CategoryParam): Promise<Response<Category>>

- Defined in admin-api/src/clients/CategoryClient.ts:71
Updates category by id

Parameters
- categoryId: number
  
  category id
- params: CategoryParam
  
  category update parameter
Returns Promise<Response<Category>>
A response of updated category.

updateInBatch

updateInBatch(params: CategoryParam[]): Promise<Response<Category[]>>

- Defined in admin-api/src/clients/CategoryClient.ts:83
Updates category in batch

Parameters
- params: CategoryParam[]
Returns Promise<Response<Category[]>>

Generated using TypeDoc