Skip to content
API/Config

Config

src/types/config.type.tstype

Driver configuration that names the driver by its id

The id-based counterpart of QubeeConfig, for configuration that arrives as a string: resolve the driver with DRIVERS[config.driver]. Allows configuring the pagination driver and customizing both request query parameter keys and response field keys.

Property Type Description
driver Driver The pagination driver to use
pagination PaginationMode Wire-level pagination mechanism. Defaults to PaginationModeEnum.QUERY when omitted. Currently honoured only by the PostgREST driver; other drivers ignore it.
request QueryBuilderConfig Custom key names for request query parameters
response PaginationConfig Custom key names for response field mapping