Skip to content

Interface: ResourcefulQueryScopeCallback()

Function type for applying query-level scoping to database queries.

These callbacks are applied to queries during CRUD operations to enforce data access boundaries based on request context. They modify the query in-place by adding WHERE clauses, JOINs, or other constraints.

ts
ResourcefulQueryScopeCallback(
   ctx: HttpContext,
   app: ApplicationService,
   query: DatabaseQueryBuilderContract,
model: ResourcefulModel): PromiseAble<void>;

Parameters

ParameterTypeDescription
ctxHttpContextHTTP context containing request information and authentication
appApplicationServiceApplication service instance for accessing app-level services
queryDatabaseQueryBuilderContractDatabase query builder to modify with scoping constraints
modelResourcefulModelThe resourceful model class the query is being built for

Returns

PromiseAble<void>

Promise that resolves when the query has been modified