Interface TestBaseEvents

Events emitted by TestBase and inherited classes

interface TestBaseEvents {
    [DESTROYED]: [er?: unknown];
    [ERROR]: [er: unknown];
    abort: [reason: unknown];
    assert: [res: Result];
    bailout: [reason?: string];
    close: [];
    complete: [results: FinalResults];
    data: [chunk: string];
    drain: [];
    end: [];
    error: [er: unknown];
    finish: [];
    idle: [];
    prefinish: [];
    readable: [];
    result: [res: Result];
    resume: [];
    spawn: [s: Spawn];
    stdin: [s: Stdin];
    subtestAdd: [p: Base<TapBaseEvents>];
    subtestEnd: [p: Base<TapBaseEvents>];
    subtestProcess: [p: Base<TapBaseEvents>];
    subtestStart: [p: Base<TapBaseEvents>];
    tapFile: [tf: TapFile];
    timeout: [threw?: Extra];
    worker: [w: Worker];
}

Hierarchy (view full)

Properties

[DESTROYED]: [er?: unknown]
[ERROR]: [er: unknown]
abort: [reason: unknown]
bailout: [reason?: string]

emitted when the test bails out

close: []
complete: [results: FinalResults]

emitted when the test is complete

data: [chunk: string]
drain: []
end: []
error: [er: unknown]
finish: []
prefinish: []
readable: []
resume: []
timeout: [threw?: Extra]

emitted when a timeout occurs

Events

assert: [res: Result]

Emitted when the parser emits a result, with the full parser result object

idle: []

Emitted when the test is in an idle state, not waiting for anything, with nothing in its queue. Used by the root @tapjs/core!tap.TAP singleton to know when to automatically terminate.

result: [res: Result]

Emitted whenever the test has an assertion result, with the minimal { ok, message, extra } result object.

spawn: [s: Spawn]

Emitted when a child test is initiated that will process a subprocess output as a TAP stream

stdin: [s: Stdin]

Emitted when a child test is initiated that will process stdin as a TAP stream

subtestAdd: [p: Base<TapBaseEvents>]

Emitted when a subtest is added to its parent's management

subtestEnd: [p: Base<TapBaseEvents>]

Emitted when a subtest is completed and no longer active, but may not yet have been processed by the parent test.

subtestProcess: [p: Base<TapBaseEvents>]

Emitted when a subtest begins to be processed.

subtestStart: [p: Base<TapBaseEvents>]

Emitted when a subtest begins running

tapFile: [tf: TapFile]

Emitted when a child tests is initiated that replays a .tap file.

worker: [w: Worker]

Emitted when a child test is initiated that will process a node Worker thread's output as a TAP stream