All Symbols - QUnitX documentation

default

QUnitX — universal test library that runs the same test file in Node.js, Deno, and browser.

Examples

Example 1

import { module, test } from "qunitx";

module("Math", (hooks) => {
  hooks.before((assert) => assert.step("setup"));

  test("addition", (assert) => {
    assert.equal(1 + 1, 2);
  });

  test("async", async (assert) => {
    const n = await Promise.resolve(42);
    assert.strictEqual(n, 42);
  });
});

Classes

c

module: ModuleState | null,

test?: TestState

The assertion object passed to every test callback and lifecycle hook.

AssertionError: AssertionErrorConstructor
QUnit: QUnitObject
async(): () => void
Returns a done callback for callback-style async tests. The test will not finish until every done callback returned by async() has been called.
deepEqual(
actual: unknown,
expected: unknown,
message?: string
): void
Asserts deep equality between actual and expected using recursive structural comparison. Handles nested objects, arrays, Date, RegExp, and more.
equal(
actual: unknown,
expected: unknown,
message?: string
): void
Asserts that actual == expected (loose equality, allows type coercion).
expect(number: number): void
Sets the number of assertions expected to run in the current test. The test fails if a different number of assertions actually ran.
false(
state: unknown,
message?: string
): void
Asserts that state === false (strict boolean false).
inspect: InspectFn
notDeepEqual(
actual: unknown,
expected: unknown,
message?: string
): void
Asserts that actual and expected are NOT deeply equal. Inverse of Assert.prototype.deepEqual.
notEqual(
actual: unknown,
expected: unknown,
message?: string
): void
Asserts that actual != expected (loose inequality). Inverse of Assert.prototype.equal.
notOk(
state: unknown,
message?: string
): void
Asserts that state is falsy.
notPropContains(
actual: unknown,
expected: unknown,
message?: string
): void
Asserts that actual does NOT contain all own enumerable properties from expected with matching values. Inverse of Assert.prototype.propContains.
notPropEqual(
actual: unknown,
expected: unknown,
message?: string
): void
Asserts that actual and expected do NOT have the same own enumerable properties and values. Inverse of Assert.prototype.propEqual.
notStrictEqual(
actual: unknown,
expected: unknown,
message?: string
): void
Asserts that actual !== expected (strict inequality). Inverse of Assert.prototype.strictEqual.
ok(
state: unknown,
message?: string
): void
Asserts that state is truthy.
propContains(
actual: unknown,
expected: unknown,
message?: string
): void
Asserts that actual contains all own enumerable properties from expected with matching values. Extra properties on actual are allowed and ignored.
propEqual(
actual: unknown,
expected: unknown,
message?: string
): void
Asserts that actual and expected have the same own enumerable properties and values. Prototype methods are ignored; only own properties are compared.
pushResult(resultInfo?: PushResultInfo): this
Pushes a custom assertion result. Fails the test if resultInfo.result is falsy. Throws an AssertionError on failure.
rejects(
promise: unknown,
expectedInput?: unknown,
assertionMessage?: string
): Promise<void>
Asserts that a promise rejects. Optionally validates the rejection reason against a string (message substring), RegExp (message pattern), or constructor (instanceof check). For synchronous throws use Assert.prototype.throws.
step(message: string): void
Records a named step. Use with Assert.prototype.verifySteps to assert that a sequence of steps occurred in the right order.
strictEqual(
actual: unknown,
expected: unknown,
message?: string
): void
Asserts that actual === expected (strict equality, no type coercion).
test: TestState
throws(
blockFn: unknown,
expectedInput?: unknown,
assertionMessage?: string
): void
Asserts that blockFn throws an exception. Optionally validates the thrown error against a string (message substring), RegExp (message pattern), or constructor (instanceof check). For async functions use Assert.prototype.rejects.
timeout(number: number): void
Sets the number of milliseconds after which the current test will fail if not yet complete.
true(
state: unknown,
message?: string
): void
Asserts that state === true (strict boolean true).
verifySteps(
steps: string[],
message?: string
): void
Asserts that the steps recorded via Assert.prototype.step match the given array, then clears the recorded steps.
waitForAsyncOps(): Promise<void[]>

c

AssertionError(object: AssertionErrorOptions)

Thrown when an assertion fails. Extends Deno's built-in AssertionError so it integrates cleanly with Deno's test runner output.

Functions

f

N

moduleName: string,

runtimeOptions: object | ((hooks: HooksObject<Assert>) => void),

moduleContent?: (

hooks: HooksObject<Assert>,

meta: { moduleName: string; options: unknown; context: Record<string, unknown>; }

Defines a test module (suite) for Deno's BDD test runner.

f

module.skipModule(

moduleName: string,

_moduleContent?: unknown

Skips all tests inside a module. Equivalent to QUnit.module.skip. The module is registered as ignored by Deno's runner; no test bodies run.

f

module.skipModule(

moduleName: string,

_moduleContent?: unknown

Skips all tests inside a module. Equivalent to QUnit.module.skip. The module is registered as ignored by Deno's runner; no test bodies run.

f

module.skipModule(

moduleName: string,

_moduleContent?: unknown

Skips all tests inside a module. Equivalent to QUnit.module.skip. The module is registered as ignored by Deno's runner; no test bodies run.

f

module.todoModule(

moduleName: string,

_moduleContent?: unknown

Marks all tests inside a module as todo. Equivalent to QUnit.module.todo. The module is registered as ignored by Deno's runner; no test bodies run. Deno has no native "todo module" concept, so this maps to ignore.

f

module.todoModule(

moduleName: string,

_moduleContent?: unknown

Marks all tests inside a module as todo. Equivalent to QUnit.module.todo. The module is registered as ignored by Deno's runner; no test bodies run. Deno has no native "todo module" concept, so this maps to ignore.

f

module.todoModule(

moduleName: string,

_moduleContent?: unknown

Marks all tests inside a module as todo. Equivalent to QUnit.module.todo. The module is registered as ignored by Deno's runner; no test bodies run. Deno has no native "todo module" concept, so this maps to ignore.

f

N

testName: string,

runtimeOptions:

assert: Assert,

meta: { testName: string; options: unknown; context: Record<string, unknown>; }

) => void | Promise<void>),

testContent?: (

assert: Assert,

meta: { testName: string; options: unknown; context: Record<string, unknown>; }

) => void | Promise<void>

Defines an individual test within a module for Deno's BDD test runner.

f

testName: string,

_testContent?: unknown

Registers a skipped test. Equivalent to QUnit.test.skip. The test body is never executed; the test is reported as ignored by Deno's runner.

f

testName: string,

_testContent?: unknown

Registers a skipped test. Equivalent to QUnit.test.skip. The test body is never executed; the test is reported as ignored by Deno's runner.

f

testName: string,

_testContent?: unknown

Registers a skipped test. Equivalent to QUnit.test.skip. The test body is never executed; the test is reported as ignored by Deno's runner.

f

testName: string,

_testContent?: unknown

Registers a todo test. Equivalent to QUnit.test.todo. The test body is never executed; the test is reported as ignored by Deno's runner (Deno has no native todo concept).

f

testName: string,

_testContent?: unknown

Registers a todo test. Equivalent to QUnit.test.todo. The test body is never executed; the test is reported as ignored by Deno's runner (Deno has no native todo concept).

f

testName: string,

_testContent?: unknown

Registers a todo test. Equivalent to QUnit.test.todo. The test body is never executed; the test is reported as ignored by Deno's runner (Deno has no native todo concept).

Variables

v

default: { AssertionError; module; test; config; }

The default export provides the full QUnitX API as a single object.

v

Registers a skipped test. Equivalent to test.skip. The test body is never executed and the test is reported as ignored by Deno's runner.

v