telemetry
Anonymous usage telemetry hook for buildConfig.
Fire and forget: nothing here can throw, reject or delay the caller.
BuildConfigContext
Defined in: packages/core/src/telemetry.ts:18
Internal context passed by our own entry points.
Properties
trigger?
optional trigger?: TelemetryTrigger;
Defined in: packages/core/src/telemetry.ts:19
GenerationReport
Defined in: packages/core/src/telemetry.ts:37
Outcome of a documentation generation run.
Properties
durationMs
durationMs: number;
Defined in: packages/core/src/telemetry.ts:40
error?
optional error?: unknown;
Defined in: packages/core/src/telemetry.ts:42
Error thrown by the run, if any.
errorType?
optional errorType?: string;
Defined in: packages/core/src/telemetry.ts:44
Explicit error type, takes precedence over error.
noSchema?
optional noSchema?: boolean;
Defined in: packages/core/src/telemetry.ts:46
The run failed without throwing because the schema could not be loaded.
pages
pages: number;
Defined in: packages/core/src/telemetry.ts:39
postError?
optional postError?: unknown;
Defined in: packages/core/src/telemetry.ts:48
First post-processing error, when the run completed incompletely.
telemetry?
optional telemetry?: TelemetryContext;
Defined in: packages/core/src/telemetry.ts:38
TelemetryContext
Defined in: packages/core/src/telemetry.ts:31
Telemetry decision made once by buildConfig, reused at generation time.
Properties
option?
optional option?: boolean;
Defined in: packages/core/src/telemetry.ts:33
trigger?
optional trigger?: TelemetryTrigger;
Defined in: packages/core/src/telemetry.ts:32
TelemetryReport
Defined in: packages/core/src/telemetry.ts:22
Properties
cliOpts
cliOpts: Maybe<CliOptions>;
Defined in: packages/core/src/telemetry.ts:25
configFileOpts
configFileOpts: Maybe<ConfigOptions>;
Defined in: packages/core/src/telemetry.ts:23
extension
extension: Maybe<ConfigOptions>;
Defined in: packages/core/src/telemetry.ts:24
id?
optional id?: Maybe<string>;
Defined in: packages/core/src/telemetry.ts:26
trigger?
optional trigger?: TelemetryTrigger;
Defined in: packages/core/src/telemetry.ts:27
reportGeneration()
function reportGeneration(report): Promise<void>;
Defined in: packages/core/src/telemetry.ts:199
Reports the outcome of a generation run. Never throws and never rejects.
Parameters
report
Returns
Promise<void>
reportTelemetry()
function reportTelemetry(report): Promise<void>;
Defined in: packages/core/src/telemetry.ts:155
Reports the resolved configuration once per distinct config and process. Never throws and never rejects.
Parameters
report
Returns
Promise<void>
resolveTelemetryContext()
function resolveTelemetryContext(report): TelemetryContext;
Defined in: packages/core/src/telemetry.ts:100
Resolves the telemetry opt-in and trigger from the configuration sources.
Parameters
report
Pick<TelemetryReport, "cliOpts" | "configFileOpts" | "extension" | "trigger">