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

@@ -24,6 +24,17 @@ function optionalString(value) {
return s || null;
}
/**
* Creates a new address for an entity.
*
* @param {object} pool - The mssql connection pool.
* @returns {Function} An async function that creates an entity address.
*
* @example
* const fn = create(pool);
* const address = await fn(42, 1, 5, { addressType: 'billing', street: 'Main St', city: 'Berlin' });
* // => { id, entityId, firstName, name, street, streetNumber, zip, city, county, addressType, sort }
*/
export default function create(pool) {
const access = resolveCompanyAccess(pool);
const entityAccess = resolveEntityAccess(pool);

View File

@@ -2,6 +2,16 @@ import { DELETE_BY_ENTITY_AND_ID } from '../../sql/entityaddress.js';
import resolveCompanyAccess from '../companyuser/resolveCompanyAccess.js';
import resolveEntityAccess from '../entity/resolveEntityAccess.js';
/**
* Deletes an address of an entity.
*
* @param {object} pool - The mssql connection pool.
* @returns {Function} An async function that deletes an entity address.
*
* @example
* const fn = del(pool);
* await fn(42, 1, 5, 9);
*/
export default function del(pool) {
const access = resolveCompanyAccess(pool);
const entityAccess = resolveEntityAccess(pool);

View File

@@ -18,6 +18,17 @@ function shape(row) {
};
}
/**
* Lists the addresses of an entity.
*
* @param {object} pool - The mssql connection pool.
* @returns {Function} An async function that lists entity addresses.
*
* @example
* const fn = list(pool);
* const addresses = await fn(42, 1, 5);
* // => [{ id, entityId, firstName, name, street, streetNumber, zip, city, county, addressType, sort }]
*/
export default function list(pool) {
const access = resolveCompanyAccess(pool);
const entityAccess = resolveEntityAccess(pool);

View File

@@ -24,6 +24,17 @@ function optionalString(value) {
return s || null;
}
/**
* Updates an address of an entity.
*
* @param {object} pool - The mssql connection pool.
* @returns {Function} An async function that updates an entity address.
*
* @example
* const fn = update(pool);
* const address = await fn(42, 1, 5, 9, { city: 'Hamburg' });
* // => { id, entityId, firstName, name, street, streetNumber, zip, city, county, addressType, sort }
*/
export default function update(pool) {
const access = resolveCompanyAccess(pool);
const entityAccess = resolveEntityAccess(pool);