DataConnector

Factory class to define a bunch of action handlers.

Type parameters

Type parameter	Value
`P` extends `Patch`	`ItemPatch`

Constructors

new DataConnector()

new DataConnector<P>(client): DataConnector<P>

Parameters

Parameter	Type
`client`	`DataConnectorClient`

Returns

DataConnector<P>

new DataConnector()

new DataConnector<P>(client, optPatchParser): DataConnector<P>

Parameters

Parameter	Type
`client`	`DataConnectorClient`
`optPatchParser`	`P` extends `ItemPatch` ? `never` : `PatchParser`<`P`>

Returns

DataConnector<P>

Properties

actions

actions: Record<string, object | object> = {};

routes

routes: Record<string, DataConnectorRoute> = {};

Methods

defineAction()

defineAction<T>(
   name, 
   request, 
asynchronous): DataConnector<P>

Factory to define an action request handler

Type parameters

Type parameter
`T` extends `string`

Parameters

Parameter	Type	Default value
`name`	`T`	`undefined`
`request`	`ActionTypeForName`<`P`, `T`, `boolean`>	`undefined`
`asynchronous`	`boolean`	`false`

Returns

DataConnector<P>

defineAsynchronousAction()

defineAsynchronousAction<T>(name, request): DataConnector<P>

Factory to define an asynchronous action request handler

Type parameters

Type parameter
`T` extends `string`

Parameters

Parameter	Type
`name`	`T`
`request`	`ActionTypeForName`<`P`, `T`, `true`>

Returns

DataConnector<P>

defineRoute()

defineRoute(name, request): DataConnector<P>

Factory to define a route handler

Parameters

Parameter	Type
`name`	`string`
`request`	`DataConnectorRoute`

Returns

DataConnector<P>

routeDebugServer()

routeDebugServer(options): ExpressAppLike

Add a route to the given express app (or generate a new app) to serve this data connector

Parameters

Parameter	Type
`options`	`RunDebugServerOptions`

Returns

ExpressAppLike

runAction()

runAction(
   url, 
   headers, 
body): Promise<object>

Call a defined action handler and gather its serialized response

Parameters

Parameter	Type
`url`	`string`
`headers`	`Record`<`string`, `undefined` \| `string` \| `string`[]>
`body`	`unknown`

Returns

Promise<object>

body

body: unknown;

status

status: number;

runDebugServer()

runDebugServer(options): void

Serve this data connector as a simple express app for debugging purposes

Parameters

Parameter	Type
`options`	`RunDebugServerOptions`

Returns

void