@orangecheck/insights-client / InsightsClient
Interface: InsightsClient
Defined in: index.ts:93
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
<a id="property-enabled"></a> enabled | readonly | boolean | True 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
| Parameter | Type |
|---|---|
product | string |
name | string |
props? | Record<string, PropValue> |
Returns
Promise<void>
emitEvent()
emitEvent(event: InsightsEvent): Promise<void>;
Defined in: index.ts:97
Emit a fully-specified event. Resolves (never rejects).
Parameters
| Parameter | Type |
|---|---|
event | InsightsEvent |
Returns
Promise<void>