Skip to content

Latest commit

 

History

History
60 lines (40 loc) · 1.11 KB

README.md

File metadata and controls

60 lines (40 loc) · 1.11 KB
Raw

tspl

Test Planner for node:test and node:assert. It fails your tests if the number of assertions is not met, or the test plan was not completed.

Installation

npm i @matteo.collina/tspl --save-dev

(You'll also need @types/node)

Example

import test from 'node:test';
import { tspl } from '@matteo.collina/tspl';

test('tspl', (t) => {
  const { strictEqual } = tspl(t, { plan: 1 });
  strictEqual(1, 1);
});

Typescript

import test from 'node:test';
import { tspl, type Plan } from '@matteo.collina/tspl';

test('tspl', (t) => {
  const p: Plan = tspl(t, { plan: 1 });
  p.strictEqual(1, 1);
});

API

tspl(t: TestContext, options): Plan

Create a plan for the current test.

Here are the options:

  • plan: how many assertions are planned

Plan

The plan includes all exports from node:assert, as well as:

  • end(): a function to complete the plan
  • completed: a promise that will resolve when the plan is completed.

License

MIT