41 lines
1.3 KiB
Markdown
41 lines
1.3 KiB
Markdown
# optionslist
|
|
|
|
This document is auto-generated from the JSDoc comments in `src/store` by running `npm run api-doc`.
|
|
|
|
## `optionslist.getOptionsByArticleSku`
|
|
|
|
*Source: `src/store/optionslist/getOptionsByArticleSku.js`*
|
|
|
|
Returns the options list for an article by its SKU.
|
|
|
|
**Parameters**
|
|
|
|
| Name | Type | Description |
|
|
| --- | --- | --- |
|
|
| `googleAuthId` | `number` | The id of the Google auth user. |
|
|
| `sku` | `string` | The article SKU. |
|
|
| `[tx]` | `object` | Optional transaction. |
|
|
|
|
**Returns**
|
|
|
|
`Promise<Array<{id: number, articleId: number, sku: string, name: string|null, count: number, sort: number, mandated: boolean}>>`
|
|
|
|
## `optionslist.setOptionsByArticleSku`
|
|
|
|
*Source: `src/store/optionslist/setOptionsByArticleSku.js`*
|
|
|
|
Sets or clears the options list for an article.
|
|
|
|
**Parameters**
|
|
|
|
| Name | Type | Description |
|
|
| --- | --- | --- |
|
|
| `googleAuthId` | `number` | The id of the Google auth user. |
|
|
| `sku` | `string` | The master article SKU. |
|
|
| `[options=[]]` | `Array<{articleId?: number, sku?: string, count?: number, sort?: number, mandated?: boolean}>` | Array of options items. |
|
|
| `[tx]` | `object` | Optional transaction. |
|
|
|
|
**Returns**
|
|
|
|
`Promise<Array<{id: number, articleId: number, sku: string, name: string|null, count: number, sort: number, mandated: boolean}>>`
|