test/reporters
The node:test/reporters module exposes the builtin-reporters for node:test.
To access it:
import test from 'node:test/reporters';
This module is only available under the node: scheme. The following will not
work:
import test from 'node:test/reporters';
Usage in Deno
import * as mod from "node:test/reporters";
Classes
c
c
Functions
Interfaces
I
Type Aliases
T
T
Variables
v
v
class LcovReporter
extends Transform
Usage in Deno
import { LcovReporter } from "node:test/reporters";
Constructors #
#LcovReporter(opts?: Omit<TransformOptions, "writableObjectMode">) new
class SpecReporter
extends Transform
Usage in Deno
import { SpecReporter } from "node:test/reporters";
function dot
Usage in Deno
import { dot } from "node:test/reporters";
#dot(source: TestEventGenerator): AsyncGenerator<"\n"
| "."
| "X", void>The dot reporter outputs the test results in a compact format,
where each passing test is represented by a .,
and each failing test is represented by a X.
Parameters #
#source: TestEventGenerator Return Type #
AsyncGenerator<"\n"
| "."
| "X", void> function junit
Usage in Deno
import { junit } from "node:test/reporters";
#junit(source: TestEventGenerator): AsyncGenerator<string, void>The junit reporter outputs test results in a jUnit XML format.
Parameters #
#source: TestEventGenerator Return Type #
AsyncGenerator<string, void> function tap
Usage in Deno
import { tap } from "node:test/reporters";
#tap(source: TestEventGenerator): AsyncGenerator<string, void>The tap reporter outputs the test results in the TAP format.
Parameters #
#source: TestEventGenerator Return Type #
AsyncGenerator<string, void> type alias TestEvent
Usage in Deno
import { type TestEvent } from "node:test/reporters";
Definition #
{ type: "test:coverage"; data: TestCoverage; }
| { type: "test:complete"; data: TestComplete; }
| { type: "test:dequeue"; data: TestDequeue; }
| { type: "test:diagnostic"; data: DiagnosticData; }
| { type: "test:enqueue"; data: TestEnqueue; }
| { type: "test:fail"; data: TestFail; }
| { type: "test:pass"; data: TestPass; }
| { type: "test:plan"; data: TestPlan; }
| { type: "test:start"; data: TestStart; }
| { type: "test:stderr"; data: TestStderr; }
| { type: "test:stdout"; data: TestStdout; }
| { type: "test:summary"; data: TestSummary; }
| { type: "test:watch:drained"; data: undefined; } type alias TestEventGenerator
Usage in Deno
import { type TestEventGenerator } from "node:test/reporters";
variable lcov
Usage in Deno
import { lcov } from "node:test/reporters";
The lcov reporter outputs test coverage when used with the
--experimental-test-coverage flag.