@vltpkg/output

Classes

OutputEmitter

Defined in: index.ts:23

Constructors

new OutputEmitter()

new OutputEmitter(): OutputEmitter

Returns

OutputEmitter

Methods

emit()

emit<T>(eventName, payload): void

Defined in: index.ts:26

Type Parameters

• T extends keyof Events

Parameters

eventName

T

payload

Events[T]

Returns

void

off()

off<T>(eventName, handler): void

Defined in: index.ts:37

Type Parameters

• T extends keyof Events

Parameters

eventName

T

handler

(payload) => void

Returns

void

on()

on<T>(eventName, handler): void

Defined in: index.ts:30

Type Parameters

• T extends keyof Events

Parameters

eventName

T

handler

(payload) => void

Returns

void

Type Aliases

Events

type Events = object

Defined in: index.ts:3

Type declaration

graphStep

graphStep: object

graphStep.state

graphStep.state: "start" | "stop";

graphStep.step

graphStep.step: "build" | "actual" | "reify";

request

request: object

request.durationMs?

optional request.durationMs: number;

Wall-clock duration of the request in ms, set on completion.

request.method?

optional request.method: string;

HTTP method for the request, when known.

request.state

request.state: "start" | "complete" | "304" | "cache" | "stale";

request.statusCode?

optional request.statusCode: number;

HTTP status code, set on complete/304 completion events.

request.url

request.url: URL | string;

---

RequestDetails

type RequestDetails = Omit<Events['request'], 'url' | 'state'>

Defined in: index.ts:21

Optional diagnostic details attached to a request event.

Variables

emitter

const emitter: OutputEmitter

Defined in: index.ts:47

Functions

graphStep()

function graphStep(step): () => void

Defined in: index.ts:57

Parameters

step

"build" | "actual" | "reify"

Returns

Function

Returns

void

---

logRequest()

function logRequest(url, state, details): void

Defined in: index.ts:49

Parameters

url

string | URL

state

"start" | "complete" | "304" | "cache" | "stale"

details

RequestDetails = {}

Returns

void