VBI.connectors

Der Connector-Namespace auf einer VBI-Instanz.

Methoden

register

Registriert einen Connector.

Definition:

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

Rückgabe: void

Parameter:

ParameterTypBeschreibung
idVBIConnectorId-
connectorVBIConnectorLike-

get

Ruft einen Connector ab.

Definition:

get(id: VBIConnectorId): Promise<VBIConnector>

Rückgabe: Promise<VBIConnector>

Parameter:

ParameterTypBeschreibung
idVBIConnectorId-

has

Prüft, ob ein Connector registriert wurde.

Definition:

has(id: VBIConnectorId): boolean

Rückgabe: boolean

Parameter:

ParameterTypBeschreibung
idVBIConnectorId-

unregister

Hebt die Registrierung eines Connectors auf.

Definition:

unregister(id: VBIConnectorId): boolean

Rückgabe: boolean

Parameter:

ParameterTypBeschreibung
idVBIConnectorId-

VBIConnectorFactory

Eine Factory-Funktion, die einen VBIConnector verzögert erstellt.

Definition:

type VBIConnectorFactory = () => Promise<VBIConnector>

VBIConnectorLike

Ein Connector-Wert, der auf einer VBI-Instanz registriert werden kann und entweder einen direkten Connector oder eine asynchrone Factory unterstützt.

Definition:

type VBIConnectorLike = VBIConnector | VBIConnectorFactory