Function describe

  • describe<T>(...args): TestSuite<T>

  • Registers a test suite.

    Type Parameters

    • T

      The self type of the test suite body.

    Parameters

    Returns TestSuite<T>

    The test suite

    Example: Usage

    import { describe, it } from "@std/testing/bdd";
    import { assertEquals } from "@std/assert";

    describe("example", () => {
      it("should pass", () => {
        // test case
        assertEquals(2 + 2, 4);
      });
    });

Methods

ignore only skip

Methods

ignore

  • ignore<T>(...args): TestSuite<T>

  • Ignore the test suite.

    Type Parameters

    • T

    Parameters

    Returns TestSuite<T>

    Example: Usage

    import { describe, it, beforeAll } from "@std/testing/bdd";
    import { assertEquals } from "@std/assert";

    describe("example", () => {
      it("should pass", () => {
        assertEquals(2 + 2, 4);
      });
    });

    describe.ignore("example 2", () => {
      it("should pass too", () => {
        assertEquals(3 + 4, 7);
      });
    });

only

  • only<T>(...args): TestSuite<T>

  • Only execute this test suite.

    Type Parameters

    • T

    Parameters

    Returns TestSuite<T>

    Example: Usage

    import { describe, it, beforeAll } from "@std/testing/bdd";
    import { assertEquals } from "@std/assert";

    describe("example", () => {
      it("should pass", () => {
        assertEquals(2 + 2, 4);
      });
    });

    // Only this test suite will run
    describe.only("example 2", () => {
      it("should pass too", () => {
        assertEquals(3 + 4, 7);
      });
    });

skip

  • skip<T>(...args): TestSuite<T>

  • Skip the test suite.

    Type Parameters

    • T

    Parameters

    Returns TestSuite<T>

    Example: Usage

    import { describe, it, beforeAll } from "@std/testing/bdd";
    import { assertEquals } from "@std/assert";

    describe("example", () => {
      it("should pass", () => {
        assertEquals(2 + 2, 4);
      });
    });

    describe.skip("example 2", () => {
      it("should pass too", () => {
        assertEquals(3 + 4, 7);
      });
    });

Settings

Member Visibility

On This Page

Methods