function it

Additional properties on the it function.

Functions

f
it.eachTest<T>(
testName: string,
dataset: EachData<T>,
callback: EachCallback<Assert, T>
): void

Defines one test per case of dataset, each receiving its case as data. Equivalent to QUnit.test.each, and names the cases as it does: name [value] for a short string, name [index: value] for other primitives, name [index] otherwise, and name [key] for an object dataset.

Variables

v
it.only: OnlyTest<Assert>

Runs only this test, and any other only test or module: every other test is skipped. Equivalent to QUnit.test.only, and to passing { only: true }. Deno runs only these, and then fails the run on purpose, so that an only is not committed by accident.

v
it.skip: SkipTest

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.

v
it.todo: TodoTest<Assert>

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).

Additional properties on the it function.

Functions

f
it.eachTest<T>(
testName: string,
dataset: EachData<T>,
callback: EachCallback<Assert, T>
): void

Defines one test per case of dataset, each receiving its case as data. Equivalent to QUnit.test.each, and names the cases as it does: name [value] for a short string, name [index: value] for other primitives, name [index] otherwise, and name [key] for an object dataset.

Variables

v
it.only: OnlyTest<Assert>

Runs only this test, and any other only test or module: every other test is skipped. Equivalent to QUnit.test.only, and to passing { only: true }. Deno runs only these, and then fails the run on purpose, so that an only is not committed by accident.

v
it.skip: SkipTest

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.

v
it.todo: TodoTest<Assert>

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).

Additional properties on the it function.

Functions

f
it.eachTest<T>(
testName: string,
dataset: EachData<T>,
callback: EachCallback<Assert, T>
): void

Defines one test per case of dataset, each receiving its case as data. Equivalent to QUnit.test.each, and names the cases as it does: name [value] for a short string, name [index: value] for other primitives, name [index] otherwise, and name [key] for an object dataset.

Variables

v
it.only: OnlyTest<Assert>

Runs only this test, and any other only test or module: every other test is skipped. Equivalent to QUnit.test.only, and to passing { only: true }. Deno runs only these, and then fails the run on purpose, so that an only is not committed by accident.

v
it.skip: SkipTest

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.

v
it.todo: TodoTest<Assert>

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).

it(
testName: string,
testContent: (
assert: Assert,
meta: { testName: string; options: unknown; context: Record<string, unknown>; }
) => void | Promise<void>
): void

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

Wraps it() from @std/testing/bdd and handles the full QUnit lifecycle: beforeEach/afterEach hooks, async assertion waiting, and step verification.

Must be called inside a module() callback.

Examples

Example 1

import { module, test } from "qunitx";

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

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

Parameters

testName: string

Name of the test

testContent: (
assert: Assert,
meta: { testName: string; options: unknown; context: Record<string, unknown>; }
) => void | Promise<void>

Test callback receiving (assert, { testName, options })

Return Type

void
it(
testName: string,
runtimeOptions: object,
testContent: (
assert: Assert,
meta: { testName: string; options: unknown; context: Record<string, unknown>; }
) => void | Promise<void>
): void

Defines an individual test with optional Deno BDD runtime options forwarded to it().

Parameters

testName: string
runtimeOptions: object
testContent: (
assert: Assert,
meta: { testName: string; options: unknown; context: Record<string, unknown>; }
) => void | Promise<void>

Return Type

void
namespace it

Additional properties on the it function.

Functions

f
it.eachTest<T>(
testName: string,
dataset: EachData<T>,
callback: EachCallback<Assert, T>
): void

Defines one test per case of dataset, each receiving its case as data. Equivalent to QUnit.test.each, and names the cases as it does: name [value] for a short string, name [index: value] for other primitives, name [index] otherwise, and name [key] for an object dataset.

Variables

v
it.only: OnlyTest<Assert>

Runs only this test, and any other only test or module: every other test is skipped. Equivalent to QUnit.test.only, and to passing { only: true }. Deno runs only these, and then fails the run on purpose, so that an only is not committed by accident.

v
it.skip: SkipTest

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.

v
it.todo: TodoTest<Assert>

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).

Additional properties on the it function.

Functions

f
it.eachTest<T>(
testName: string,
dataset: EachData<T>,
callback: EachCallback<Assert, T>
): void

Defines one test per case of dataset, each receiving its case as data. Equivalent to QUnit.test.each, and names the cases as it does: name [value] for a short string, name [index: value] for other primitives, name [index] otherwise, and name [key] for an object dataset.

Variables

v
it.only: OnlyTest<Assert>

Runs only this test, and any other only test or module: every other test is skipped. Equivalent to QUnit.test.only, and to passing { only: true }. Deno runs only these, and then fails the run on purpose, so that an only is not committed by accident.

v
it.skip: SkipTest

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.

v
it.todo: TodoTest<Assert>

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).

Additional properties on the it function.

Functions

f
it.eachTest<T>(
testName: string,
dataset: EachData<T>,
callback: EachCallback<Assert, T>
): void

Defines one test per case of dataset, each receiving its case as data. Equivalent to QUnit.test.each, and names the cases as it does: name [value] for a short string, name [index: value] for other primitives, name [index] otherwise, and name [key] for an object dataset.

Variables

v
it.only: OnlyTest<Assert>

Runs only this test, and any other only test or module: every other test is skipped. Equivalent to QUnit.test.only, and to passing { only: true }. Deno runs only these, and then fails the run on purpose, so that an only is not committed by accident.

v
it.skip: SkipTest

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.

v
it.todo: TodoTest<Assert>

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).

it(
testName: string,
testContent: (
assert: Assert,
meta: { testName: string; options: unknown; context: Record<string, unknown>; }
) => void | Promise<void>
): void

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

Wraps it() from @std/testing/bdd and handles the full QUnit lifecycle: beforeEach/afterEach hooks, async assertion waiting, and step verification.

Must be called inside a module() callback.

Examples

Example 1

import { module, test } from "qunitx";

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

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

Parameters

testName: string

Name of the test

testContent: (
assert: Assert,
meta: { testName: string; options: unknown; context: Record<string, unknown>; }
) => void | Promise<void>

Test callback receiving (assert, { testName, options })

Return Type

void
it(
testName: string,
runtimeOptions: object,
testContent: (
assert: Assert,
meta: { testName: string; options: unknown; context: Record<string, unknown>; }
) => void | Promise<void>
): void

Defines an individual test with optional Deno BDD runtime options forwarded to it().

Parameters

testName: string
runtimeOptions: object
testContent: (
assert: Assert,
meta: { testName: string; options: unknown; context: Record<string, unknown>; }
) => void | Promise<void>

Return Type

void

Usage

import { it } from ".";