Interface describe

constructor

ignore

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

• Registers a test suite with ignore set to true.

  Type Parameters

  • T

  Parameters

  • Rest...args: DescribeArgs<T>

  Returns TestSuite<T>

only

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

• Registers a test suite with only set to true.

  Type Parameters

  • T

  Parameters

  • Rest...args: DescribeArgs<T>

  Returns TestSuite<T>

skip

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

• Registers a test suite with ignore set to true. Alias of .ignore().

  Type Parameters

  • T

  Parameters

  • Rest...args: ItArgs<T>

  Returns void

Staticignore

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

• Ignore the test suite.

  Type Parameters

  • T

  Parameters

  • Rest...args: DescribeArgs<T>

    The test suite body

  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);
    });
  });
  Copy

Staticonly

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

• Only execute this test suite.

  Type Parameters

  • T

  Parameters

  • Rest...args: DescribeArgs<T>

    The test suite body

  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);
    });
  });
  Copy

Staticskip

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

• Skip the test suite.

  Type Parameters

  • T

  Parameters

  • Rest...args: DescribeArgs<T>

    The test suite body

  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);
    });
  });
  Copy