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

@@ -1,6 +1,16 @@
import { DELETE_BY_COMPANY_AND_ID } from '../../sql/brand.js';
import resolveCompanyAccess from '../companyuser/resolveCompanyAccess.js';
/**
* Deletes a brand for a company by its id.
*
* @param {object} pool - The mssql connection pool.
* @returns {Function} An async function that deletes a brand.
*
* @example
* const fn = del(pool);
* await fn(42, 1, 3);
*/
export default function del(pool) {
const access = resolveCompanyAccess(pool);

View File

@@ -1,6 +1,17 @@
import { LIST_BY_COMPANY } from '../../sql/brand.js';
import resolveCompanyAccess from '../companyuser/resolveCompanyAccess.js';
/**
* Lists the brands of a company.
*
* @param {object} pool - The mssql connection pool.
* @returns {Function} An async function that lists brands.
*
* @example
* const fn = list(pool);
* const brands = await fn(42, 1);
* // => [{ id, name, gsprpinfo }]
*/
export default function list(pool) {
const access = resolveCompanyAccess(pool);

View File

@@ -5,6 +5,17 @@ import {
} from '../../sql/brand.js';
import resolveCompanyAccess from '../companyuser/resolveCompanyAccess.js';
/**
* Creates or updates a brand for a company, keyed by name.
*
* @param {object} pool - The mssql connection pool.
* @returns {Function} An async function that upserts a brand.
*
* @example
* const fn = upsert(pool);
* const brand = await fn(42, 1, { name: 'Coca-Cola', gsprpinfo: 'x' });
* // => { id, name, gsprpinfo }
*/
export default function upsert(pool) {
const access = resolveCompanyAccess(pool);