track
TrackInput
Defined in: track.ts:11
Extends
Omit<PayloadInput,"noStateBefore">
Properties
cli?
optional cli?: CliOptions;
Defined in: payload.ts:24
Inherited from
config?
optional config?: ConfigOptions;
Defined in: payload.ts:23
Inherited from
durationMs?
optional durationMs?: number;
Defined in: payload.ts:30
Inherited from
env?
optional env?: ProcessEnv;
Defined in: payload.ts:34
Inherited from
errorType?
optional errorType?: string;
Defined in: payload.ts:31
Inherited from
event?
optional event?: TelemetryEvent;
Defined in: payload.ts:17
Inherited from
graphqlMajor?
optional graphqlMajor?: unknown;
Defined in: payload.ts:22
versionInfo.major of the loaded graphql.
Inherited from
mode?
optional mode?: "scaffold" | "wire";
Defined in: payload.ts:27
Inherited from
onFullNotice?
optional onFullNotice?: (notice) => void;
Defined in: track.ts:17
Receives the full notice instead of stderr (e.g. a prompt UI).
Parameters
notice
string
Returns
void
option?
optional option?: boolean;
Defined in: track.ts:13
Value of the telemetry option.
pages?
optional pages?: number;
Defined in: payload.ts:29
Generate events only.
Inherited from
pkg
pkg: string;
Defined in: payload.ts:19
Inherited from
pkgVersion
pkgVersion: string;
Defined in: payload.ts:20
Inherited from
statePath?
optional statePath?: string;
Defined in: track.ts:15
Override of the telemetry.json location (tests).
target?
optional target?: string;
Defined in: payload.ts:26
Create events only.
Inherited from
trigger
trigger: TelemetryTrigger;
Defined in: payload.ts:18
Inherited from
encodeBody()
function encodeBody(json): object;
Defined in: track.ts:21
Builds the request body, gzipped above the size threshold.
Parameters
json
string
Returns
object
body
body: BodyInit;
headers
headers: Record<string, string>;
track()
function track(input): Promise<void>;
Defined in: track.ts:37
Sends one anonymous config event. Never throws and never rejects.
Parameters
input
Returns
Promise<void>