Logo for jsDocs.io

jest-circus

  • Version 29.7.0
  • Published
  • 72 kB
  • 20 dependencies
  • MIT license

Install

npm i jest-circus
yarn add jest-circus
pnpm add jest-circus

Overview

[type-definitions]: https://github.com/jestjs/jest/blob/main/packages/jest-types/src/Circus.ts

Index

Variables

Functions

Type Aliases

Variables

variable _default

const _default: {
    afterAll: THook;
    afterEach: THook;
    beforeAll: THook;
    beforeEach: THook;
    describe: {
        (blockName: Global.BlockNameLike, blockFn: Global.BlockFn): void;
        each: Global.EachTestFn<any>;
        only: {
            (blockName: Global.BlockNameLike, blockFn: Global.BlockFn): void;
            each: Global.EachTestFn<any>;
        };
        skip: {
            (blockName: Global.BlockNameLike, blockFn: Global.BlockFn): void;
            each: Global.EachTestFn<any>;
        };
    };
    it: Global.It;
    test: Global.It;
};

    variable afterAll

    const afterAll: THook;

      variable afterEach

      const afterEach: THook;

        variable beforeAll

        const beforeAll: THook;

          variable beforeEach

          const beforeEach: THook;

            variable describe

            const describe: {
                (blockName: Circus.BlockNameLike, blockFn: Circus.BlockFn): void;
                each: Global.EachTestFn<any>;
                only: {
                    (blockName: Circus.BlockNameLike, blockFn: Circus.BlockFn): void;
                    each: Global.EachTestFn<any>;
                };
                skip: {
                    (blockName: Circus.BlockNameLike, blockFn: Circus.BlockFn): void;
                    each: Global.EachTestFn<any>;
                };
            };

              variable it

              const it: Global.It;

                variable test

                const test: Global.It;

                  Functions

                  function getState

                  getState: () => Circus.State;

                    function resetState

                    resetState: () => void;

                      function run

                      run: () => Promise<Circus.RunResult>;

                        function setState

                        setState: (state: Circus.State) => Circus.State;

                          Type Aliases

                          type Event

                          type Event_2 = Circus.Event;

                            type State

                            type State = Circus.State;

                              Package Files (1)

                              Dependencies (20)

                              Dev Dependencies (8)

                              Peer Dependencies (0)

                              No peer dependencies.

                              Badge

                              To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                              You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/jest-circus.

                              • Markdown
                                [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/jest-circus)
                              • HTML
                                <a href="https://www.jsdocs.io/package/jest-circus"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>