index
Classes
OutputEmitter
Defined in: index.ts:24
Constructors
new OutputEmitter()
new OutputEmitter(): OutputEmitterReturns
Methods
emit()
emit<T>(eventName, payload): voidDefined in: index.ts:27
Type Parameters
| Type Parameter |
|---|
T extends keyof Events |
Parameters
| Parameter | Type |
|---|---|
eventName | T |
payload | Events[T] |
Returns
void
off()
off<T>(eventName, handler): voidDefined in: index.ts:38
Type Parameters
| Type Parameter |
|---|
T extends keyof Events |
Parameters
| Parameter | Type |
|---|---|
eventName | T |
handler | (payload) => void |
Returns
void
on()
on<T>(eventName, handler): voidDefined in: index.ts:31
Type Parameters
| Type Parameter |
|---|
T extends keyof Events |
Parameters
| Parameter | Type |
|---|---|
eventName | T |
handler | (payload) => void |
Returns
void
Type Aliases
Events
type Events = object;Defined in: index.ts:3
Type declaration
| Name | Type | Description |
|---|---|---|
graphStep | object | - |
graphStep.state | "start" | "stop" | - |
graphStep.step | "build" | "actual" | "reify" | - |
request | object | - |
request.durationMs? | number | Wall-clock duration of the request in ms, set on completion. |
request.method? | string | HTTP method for the request, when known. |
request.state | "start" | "complete" | "304" | "cache" | "stale" | "store" | store: hardlinked from the global store, no tarball read |
request.statusCode? | number | HTTP status code, set on complete/304 completion events. |
request.url | URL | string | - |
RequestDetails
type RequestDetails = Omit<Events["request"], "url" | "state">;Defined in: index.ts:22
Optional diagnostic details attached to a request event.
Variables
emitter
const emitter: OutputEmitter;Defined in: index.ts:48
Functions
graphStep()
function graphStep(step): () => voidDefined in: index.ts:58
Parameters
| Parameter | Type |
|---|---|
step | "build" | "actual" | "reify" |
Returns
Function
Returns
void
logRequest()
function logRequest(
url,
state,
details): voidDefined in: index.ts:50
Parameters
| Parameter | Type |
|---|---|
url | string | URL |
state | "start" | "complete" | "304" | "cache" | "stale" | "store" |
details | RequestDetails |
Returns
void