@zendesk/retrace/cjs/v3/hooksTypes.d.ts

define and capture Product Operation Traces along with computed metrics with an optional friendly React beacon API

import type { Attributes } from './spanTypes';
import type { TraceManager } from './TraceManager';
import type { RelatedTo } from './types';
export type RenderedOutput = 'null' | 'loading' | 'content' | 'error';
export type BeaconConfig<RelationSchemasT, RequiredAttributesT = {}> = {
    name: string;
    relatedTo: RelatedTo<RelationSchemasT>;
    renderedOutput: RenderedOutput;
    isIdle?: boolean;
    error?: Error;
} & (keyof RequiredAttributesT extends never ? {
    attributes?: Attributes;
} : {
    attributes: RequiredAttributesT & Attributes;
});
export type UseBeacon<RelationSchemasT, RequiredAttributesT> = (beaconConfig: BeaconConfig<RelationSchemasT, RequiredAttributesT>) => void;
export type GetRelationSchemasTFromTraceManager<TraceManagerT extends TraceManager<any>> = TraceManagerT extends TraceManager<infer RelationSchemasT> ? RelationSchemasT : never;