DriverDefinition

src/types/driver-definition.type.ts3 public methodstype

Per-driver factory bundle

Names the four pieces a driver contributes — request strategy, response strategy, response-options subclass — so adding a driver is one entry in DRIVERS instead of three parallel switch cases in the provider builder.

Properties

Property	Type	Description
id	DriverId	The driver’s identifier. For a built-in driver it duplicates its key in DRIVERS, which test/drivers.spec.ts asserts stays true. Carrying it on the definition lets a driver be passed around on its own — createQubee({ driver: STRAPI_DRIVER }) — while still naming the driver in capability errors. A driver defined outside this package uses its own id rather than borrowing a built-in one, so those errors name it correctly.

Methods

createRequestStrategy()

createRequestStrategy(paginationMode: PaginationModeEnum): IRequestStrategy

Build the request strategy for this driver

Receives the configured PaginationModeEnum; only PostgREST actually consults it today (RANGE-header mode), other drivers ignore the argument.

Parameter	Type	Description
paginationMode	PaginationModeEnum	Wire-level pagination mechanism

Returns — A fresh request strategy instance

createResponseOptions()

createResponseOptions(config: PaginationConfig): ResponseOptions

Build the driver-specific ResponseOptions instance

Honours user-supplied key-path overrides via PaginationConfig.

Parameter	Type	Description
config	PaginationConfig	User-supplied response key overrides

Returns — A ResponseOptions (or subclass) carrying the resolved defaults

createResponseStrategy()

createResponseStrategy(): IResponseStrategy

Build the response strategy for this driver

Returns — A fresh response strategy instance