Logo for jsDocs.io

@jest/globals

  • Version 29.3.1
  • Published
  • 5.17 kB
  • 4 dependencies
  • MIT license

Install

npm i @jest/globals
yarn add @jest/globals
pnpm add @jest/globals

Overview

Overview not available.

Index

Variables

Namespaces

Variables

variable afterAll

const afterAll: Global.GlobalAdditions;

    variable afterEach

    const afterEach: Global.GlobalAdditions;

      variable beforeAll

      const beforeAll: Global.GlobalAdditions;

        variable beforeEach

        const beforeEach: Global.GlobalAdditions;

          variable describe

          const describe: Global.GlobalAdditions;

            variable expect

            const expect: JestExpect;

              variable fdescribe

              const fdescribe: Global.GlobalAdditions;

                variable fit

                const fit: Global.GlobalAdditions;

                  variable it

                  const it: Global.GlobalAdditions;

                    variable jest

                    const jest: Jest;

                      variable test

                      const test: Global.GlobalAdditions;

                        variable xdescribe

                        const xdescribe: Global.GlobalAdditions;

                          variable xit

                          const xit: Global.GlobalAdditions;

                            variable xtest

                            const xtest: Global.GlobalAdditions;

                              Namespaces

                              namespace jest

                              namespace jest {}

                                type Mock

                                type Mock<T extends FunctionLike = UnknownFunction> = JestMock<T>;

                                • Constructs the type of a mock function, e.g. the return type of jest.fn().

                                type Mocked

                                type Mocked<T extends object> = JestMocked<T>;

                                • Wraps a class, function or object type with Jest mock type definitions.

                                type MockedClass

                                type MockedClass<T extends ClassLike> = JestMockedClass<T>;

                                • Wraps a class type with Jest mock type definitions.

                                type MockedFunction

                                type MockedFunction<T extends FunctionLike> = JestMockedFunction<T>;

                                • Wraps a function type with Jest mock type definitions.

                                type MockedObject

                                type MockedObject<T extends object> = JestMockedObject<T>;

                                • Wraps an object type with Jest mock type definitions.

                                type Spied

                                type Spied<T extends ClassLike | FunctionLike> = JestSpied<T>;

                                • Constructs the type of a spied class or function.

                                type SpiedClass

                                type SpiedClass<T extends ClassLike> = JestSpiedClass<T>;

                                • Constructs the type of a spied class.

                                type SpiedFunction

                                type SpiedFunction<T extends FunctionLike> = JestSpiedFunction<T>;

                                • Constructs the type of a spied function.

                                type SpiedGetter

                                type SpiedGetter<T> = JestSpiedGetter<T>;

                                • Constructs the type of a spied getter.

                                type SpiedSetter

                                type SpiedSetter<T> = JestSpiedSetter<T>;

                                • Constructs the type of a spied setter.

                                Package Files (1)

                                Dependencies (4)

                                Dev Dependencies (0)

                                No dev dependencies.

                                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/globals.

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