docs: add JSDoc headers to all externally exported store functions

This commit is contained in:
seb
2026-08-07 03:58:48 +02:00
parent c290fe8f4b
commit 4833acd680
101 changed files with 1134 additions and 0 deletions

View File

@@ -5,6 +5,17 @@ import {
import resolveCompanyAccess from '../companyuser/resolveCompanyAccess.js';
import shapeSetting from './shapeSetting.js';
/**
* Lists the settings of a company, optionally only frontend-visible ones.
*
* @param {object} pool - The mssql connection pool.
* @returns {Function} An async function that lists company settings.
*
* @example
* const fn = list(pool);
* const settings = await fn(42, 1, { frontendOnly: true });
* // => [{ key, value, frontend }]
*/
export default function list(pool) {
const access = resolveCompanyAccess(pool);