@adonis-agora/filter/dist/providers/filter_provider.d.ts

Server-side query filtering/sorting/pagination for AdonisJS — Spatie-style input, a Lucid adapter, and field allow-listing. Part of the Agora ecosystem.

import type { ApplicationService } from '@adonisjs/core/types';
/**
 * Wires `@adonis-agora/filter`'s chainable Lucid macros into the application.
 *
 * On boot it registers the `applyFilterFromRequest` and `filterPaginate` macros
 * onto Lucid's `ModelQueryBuilder`, so any model query gains the method-call form
 * of the free `applyFilterFromRequest` helper:
 *
 * ```ts
 * const rows = await User.query()
 *   .where('tenantId', tenant.id)
 *   .applyFilterFromRequest(userFilter, ctx)
 *   .orderBy('createdAt', 'desc')
 *
 * const page = await User.query().filterPaginate(userFilter, ctx)
 * ```
 *
 * Register it in `adonisrc.ts` (`providers`). The free functions
 * (`applyFilterFromRequest`, `applyCursorFromRequest`) work without it — this
 * provider only adds the chainable sugar, so `@adonisjs/lucid` is loaded lazily
 * here (not a hard dependency of the package).
 */
export default class FilterProvider {
    protected app: ApplicationService;
    constructor(app: ApplicationService);
    boot(): Promise<void>;
}
//# sourceMappingURL=filter_provider.d.ts.map