oc · docs
docs / documentation

@orangecheck/insights-client


@orangecheck/insights-client / InsightsClient

Interface: InsightsClient

Defined in: index.ts:93

Properties

PropertyModifierTypeDescriptionDefined in
<a id="property-enabled"></a> enabledreadonlybooleanTrue when a token + url + fetch are present. When false, emit is an inert no-op.index.ts:99

Methods

emit()

emit(
   product: string, 
   name: string, 
props?: Record<string, PropValue>): Promise<void>;

Defined in: index.ts:95

Convenience: emit(product, name, props). Resolves (never rejects).

Parameters

ParameterType
productstring
namestring
props?Record&lt;string, PropValue>

Returns

Promise&lt;void>


emitEvent()

emitEvent(event: InsightsEvent): Promise<void>;

Defined in: index.ts:97

Emit a fully-specified event. Resolves (never rejects).

Parameters

ParameterType
eventInsightsEvent

Returns

Promise&lt;void>