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,18 @@
import { QUOTE_TYPE } from '../../sql/manifestDoc.js';
import createManifestDocStore from '../manifestDoc/createStore.js';
/**
* Creates a quote store (list, getById, create, update, delete) backed by the
* manifest / manifestarticle tables.
*
* @param {object} pool - The mssql connection pool.
* @returns {object} An object with `list`, `getById`, `create`, `update` and `delete` functions.
*
* @example
* const store = createQuoteStore(pool);
* const quotes = await store.list(42, 1);
* // => [{ id, number, type, entityId, date }]
*/
export default function createQuoteStore(pool) {
return createManifestDocStore(pool, { type: QUOTE_TYPE, label: 'Quote' });
}