dashlibstorage/API.runner.js.md

runner.js

This document is auto-generated from the JSDoc comments in src/store by running npm run api-doc.

runner.js.runner

Source: src/store/runner.js

Resolves the object a store method should query through. Converted store modules call runner(sql, params) or runner.query(sql, params). During the incremental migration they may still be constructed with a raw mssql pool, or called with a raw mssql Transaction as tx. This adapter exposes the unified runner contract over both so mixed call sites keep working until every module is converted.

Parameters

Name	Type	Description
provider	import('../providers/provider.js').DatabaseProvider
[tx]	object	Optional provider runner or legacy mssql Transaction.

Returns

((sql: string, params?: object) => Promise<import('../providers/provider.js').QueryResult>) & { query: Function, dialect?: string }