1.7 KiB
categoryproperty
This document is auto-generated from the JSDoc comments in src/store by running npm run api-doc.
categoryproperty.delete
Source: src/store/categoryproperty/delete.js
Deletes a property from a category by categoryId and propertyId.
Parameters
| Name | Type | Description |
|---|---|---|
googleAuthId |
number |
The id of the Google auth user. |
categoryId |
number |
The category ID. |
propertyId |
number |
The property id. |
[tx] |
object |
Optional transaction. |
Returns
Promise<void>
categoryproperty.listByCategoryId
Source: src/store/categoryproperty/listByCategoryId.js
Lists the properties of a category by its ID.
Parameters
| Name | Type | Description |
|---|---|---|
googleAuthId |
number |
The id of the Google auth user. |
categoryId |
number |
The category ID. |
[tx] |
object |
Optional transaction. |
Returns
Promise<Array<{id: number, categoryId: number, propertyId: number, name: string, exclusive: boolean, value: string, sort: number}>>
categoryproperty.setByCategoryId
Source: src/store/categoryproperty/setByCategoryId.js
Replaces all properties for a category by its ID. Enforces exclusive flag on property names.
Parameters
| Name | Type | Description |
|---|---|---|
googleAuthId |
number |
The id of the Google auth user. |
categoryId |
number |
The category ID. |
properties |
Array<{propertyId: number, value: string, sort?: number}> |
The properties to set. |
[tx] |
object |
Optional transaction. |
Returns
Promise<Array<{id: number, categoryId: number, propertyId: number, name: string, exclusive: boolean, value: string, sort: number}>>