VBI.resources.insight

The insight resource namespace on a VBI instance.

Methods

register

Registers a single insight resource.

Definition:

register(insight: VBIInsightDSLInput): VBIInsightDSL

Returns: VBIInsightDSL

Parameters:

ParameterTypeDescription
insightVBIInsightDSLInput-

get

Gets a registered insight resource DSL.

Definition:

get(uuid: string): VBIInsightDSL | undefined

Returns: VBIInsightDSL \| undefined

Parameters:

ParameterTypeDescription
uuidstring-

list

Gets all registered insight resource DSLs.

Definition:

list(): VBIInsightDSL[]

Returns: VBIInsightDSL[]

has

Checks whether the specified insight resource has been registered.

Definition:

has(uuid: string): boolean

Returns: boolean

Parameters:

ParameterTypeDescription
uuidstring-

unregister

Unregisters the specified insight resource.

Definition:

unregister(uuid: string): boolean

Returns: boolean

Parameters:

ParameterTypeDescription
uuidstring-