Skip to main content

enabled

EnabledContext​

Defined in: enabled.ts:6

Properties​

env?​

optional env?: ProcessEnv;

Defined in: enabled.ts:13

option?​

optional option?: boolean;

Defined in: enabled.ts:10

Value of the telemetry option (config, programmatic or CLI).

state?​

optional state?: TelemetryState | null;

Defined in: enabled.ts:12

State file content; null means corrupt, undefined means absent.

trigger?​

optional trigger?: TelemetryTrigger;

Defined in: enabled.ts:8

Entry point; without it only telemetry: true enables (programmatic).

getEndpoint()​

function getEndpoint(env?): string;

Defined in: enabled.ts:16

Parameters​

env?​

ProcessEnv = process.env

Returns​

string

isEnabled()​

function isEnabled(ctx?):
  | {
      enabled: false;
    }
  | {
      enabled: true;
      trigger: TelemetryTrigger;
    };

Defined in: enabled.ts:30

Resolves whether telemetry is enabled and with which trigger. User-level and environment signals always beat project config.

Parameters​

ctx?​

EnabledContext = {}

Returns​

| { enabled: false; } | { enabled: true; trigger: TelemetryTrigger; }