Skip to main content

foundation-comms.datasource.init

Home > @genesislcap/foundation-comms > Datasource > init

Datasource.init() method

Initializes the datasource with the given options and fetches metadata if specified.

Signature:

init(options: DatasourceOptions, fetchMeta?: boolean, startStream?: boolean): Promise<boolean>;

Parameters

Parameter

Type

Description

options

DatasourceOptions

The options to initialize the datasource with.

fetchMeta

boolean

(Optional) Optional flag to fetch metadata for the datasource. Defaults to true.

startStream

boolean

(Optional) Optional flag to start the data stream. Defaults to true.

Returns:

Promise<boolean>

A promise that resolves with a boolean indicating whether the initialization was successful.