Skip to main content
Version: next

IConfig

Defined in: src/lib/interfaces/config.interface.ts:21

Main configuration interface for ng-qubee

Allows configuring the pagination driver and customizing both request query parameter keys and response field keys.

Example​

const config: IConfig = {
  driver: DriverEnum.NESTJS,
  request: { filters: 'filter', sort: 'sortBy' },
  response: { data: 'data' }
};

Properties​

driver​

driver: DriverEnum

Defined in: src/lib/interfaces/config.interface.ts:23

The pagination driver to use

pagination?​

optional pagination?: PaginationModeEnum

Defined in: src/lib/interfaces/config.interface.ts:29

Wire-level pagination mechanism. Defaults to PaginationModeEnum.QUERY when omitted. Currently honoured only by the PostgREST driver; other drivers ignore it.

request?​

optional request?: IQueryBuilderConfig

Defined in: src/lib/interfaces/config.interface.ts:31

Custom key names for request query parameters

response?​

optional response?: IPaginationConfig

Defined in: src/lib/interfaces/config.interface.ts:33

Custom key names for response field mapping