Skip to main content

payload

PayloadInput​

Defined in: payload.ts:16

Properties​

cli?​

optional cli?: CliOptions;

Defined in: payload.ts:24

config?​

optional config?: ConfigOptions;

Defined in: payload.ts:23

durationMs?​

optional durationMs?: number;

Defined in: payload.ts:30

env?​

optional env?: ProcessEnv;

Defined in: payload.ts:34

errorType?​

optional errorType?: string;

Defined in: payload.ts:31

event?​

optional event?: TelemetryEvent;

Defined in: payload.ts:17

graphqlMajor?​

optional graphqlMajor?: unknown;

Defined in: payload.ts:22

versionInfo.major of the loaded graphql.

mode?​

optional mode?: "scaffold" | "wire";

Defined in: payload.ts:27

noStateBefore?​

optional noStateBefore?: boolean;

Defined in: payload.ts:33

True only when no state file existed before this run.

pages?​

optional pages?: number;

Defined in: payload.ts:29

Generate events only.

pkg​

pkg: string;

Defined in: payload.ts:19

pkgVersion​

pkgVersion: string;

Defined in: payload.ts:20

target?​

optional target?: string;

Defined in: payload.ts:26

Create events only.

trigger​

trigger: TelemetryTrigger;

Defined in: payload.ts:18


buildPayload()​

function buildPayload(input): TelemetryPayload;

Defined in: payload.ts:101

Parameters​

input​

PayloadInput

Returns​

TelemetryPayload


fingerprint()​

function fingerprint(payload): string;

Defined in: payload.ts:179

SHA-256 of the canonical sorted-key JSON, excluding firstRun.

Parameters​

payload​

TelemetryPayload

Returns​

string