aefd97a171
- Rewrite JSDoc across all store methods to document the actual async methods (real params, returns, throws) instead of the internal wrappers - Split quote/order into individual module files backed by shared manifestDoc helpers; remove the createStore factory and thin wrappers - Deduplicate manifest line helpers into src/store/manifestLines.js - Extend generate-api-doc.js to render parameter/return/throws types and emit per-namespace API.<module>.md files with an API.md index - Regenerate all API docs
2.7 KiB
companysetting
This document is auto-generated from the JSDoc comments in src/store by running npm run api-doc.
companysetting.delete
Source: src/store/companysetting/delete.js
Deletes a company setting by key for the user's selected company.
Parameters
| Name | Type | Description |
|---|---|---|
googleAuthId |
number |
The id of the Google auth user. |
key |
string |
The setting key. |
Returns
Promise<void>
Throws
Error — If the setting is not found.
Example
await store.companysetting.delete(42, 'theme');
companysetting.get
Source: src/store/companysetting/get.js
Returns a single company setting by key for the user's selected company.
Parameters
| Name | Type | Description |
|---|---|---|
googleAuthId |
number |
The id of the Google auth user. |
key |
string |
The setting key. |
[options] |
object |
Optional options. |
[options.frontendOnly] |
boolean |
Only return the setting if it is frontend-visible. |
Returns
Promise<{key: string, value: string, frontend: boolean}|undefined> — The setting, or undefined if not found.
Example
const setting = await store.companysetting.get(42, 'theme');
// => { key, value, frontend }
companysetting.list
Source: src/store/companysetting/list.js
Lists the settings of the user's selected company, optionally only frontend-visible ones.
Parameters
| Name | Type | Description |
|---|---|---|
googleAuthId |
number |
The id of the Google auth user. |
[options] |
object |
Optional options. |
[options.frontendOnly] |
boolean |
Only return frontend-visible settings. |
Returns
Promise<Array<{key: string, value: string, frontend: boolean}>> — The settings.
Example
const settings = await store.companysetting.list(42, { frontendOnly: true });
// => [{ key, value, frontend }]
companysetting.set
Source: src/store/companysetting/set.js
Sets (upserts) a company setting by key for the user's selected company.
Parameters
| Name | Type | Description |
|---|---|---|
googleAuthId |
number |
The id of the Google auth user. |
input |
object |
The setting input. |
input.key |
string |
The setting key. |
input.value |
string |
The setting value. |
[input.frontend] |
boolean |
Whether the setting is frontend-visible. |
Returns
Promise<{key: string, value: string, frontend: boolean}> — The upserted setting.
Throws
Error — If the input is invalid.
Example
const setting = await store.companysetting.set(42, { key: 'theme', value: 'dark', frontend: true });
// => { key, value, frontend }