#VBI.connectors

The connector namespace on a VBI instance.

#Methods

#register

Registers a connector.

Definition:

register(id: VBIConnectorId, connector: VBIConnectorLike): void

Returns: void

Parameters:

#get

Gets a connector.

Definition:

get(id: VBIConnectorId): Promise<VBIConnector>

Returns: Promise<VBIConnector>

Parameters:

#has

Checks whether a connector has been registered.

Definition:

has(id: VBIConnectorId): boolean

Returns: boolean

Parameters:

#unregister

Unregisters a connector.

Definition:

unregister(id: VBIConnectorId): boolean

Returns: boolean

Parameters:

#VBIConnectorFactory

A factory function that lazily creates a VBIConnector.

Definition:

type VBIConnectorFactory = () => Promise<VBIConnector>

#VBIConnectorLike

A connector value that can be registered on a VBI instance, supporting either a direct connector or an async factory.

Definition:

type VBIConnectorLike = VBIConnector | VBIConnectorFactory