docs: add JSDoc headers to all externally exported store functions
This commit is contained in:
@@ -2,6 +2,17 @@ import { GET_BY_COMPANY_AND_KEY, UPSERT } from '../../sql/companysetting.js';
|
||||
import resolveCompanyAccess from '../companyuser/resolveCompanyAccess.js';
|
||||
import shapeSetting from './shapeSetting.js';
|
||||
|
||||
/**
|
||||
* Sets (upserts) a company setting by key.
|
||||
*
|
||||
* @param {object} pool - The mssql connection pool.
|
||||
* @returns {Function} An async function that sets a company setting.
|
||||
*
|
||||
* @example
|
||||
* const fn = set(pool);
|
||||
* const setting = await fn(42, 1, { key: 'theme', value: 'dark', frontend: true });
|
||||
* // => { key, value, frontend }
|
||||
*/
|
||||
export default function set(pool) {
|
||||
const access = resolveCompanyAccess(pool);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user