jest-each

jest-each

Version 29.7.0
Published 1 year ago
33.7 kB
5 dependencies
MIT license

Install

npm i jest-each

yarn add jest-each

pnpm add jest-each

Overview

Parameterised tests for Jest

Index

Variables

each

Functions

bind()
install()

Variables

variable each

const each: {
    (table: Global.EachTable, ...data: Global.TemplateData): ReturnType<
        typeof install
    >;
    withGlobal(
        g: Global
    ): (
        table: Global.EachTable,
        ...data: Global.TemplateData
    ) => {
        describe: {
            (
                title: string,
                suite: Global.EachTestFn<Global.BlockFn>,
                timeout?: number
            ): any;
            skip: any;
            only: any;
        };
        fdescribe: any;
        fit: any;
        it: {
            (
                title: string,
                test: Global.EachTestFn<Global.TestFn>,
                timeout?: number
            ): any;
            skip: any;
            only: any;
            concurrent: {
                (
                    title: string,
                    test: Global.EachTestFn<Global.TestFn>,
                    timeout?: number
                ): any;
                only: any;
                skip: any;
            };
        };
        test: {
            (
                title: string,
                test: Global.EachTestFn<Global.TestFn>,
                timeout?: number
            ): any;
            skip: any;
            only: any;
            concurrent: {
                (
                    title: string,
                    test: Global.EachTestFn<Global.TestFn>,
                    timeout?: number
                ): any;
                only: any;
                skip: any;
            };
        };
        xdescribe: any;
        xit: any;
        xtest: any;
    };
};

Functions

function bind

bind: <EachCallback extends Global.TestCallback>(
    cb: GlobalCallback,
    supportsDone?: boolean,
    needsEachError?: boolean
) => Global.EachTestFn<any>;

function install

install: (
    g: Global,
    table: Global.EachTable,
    ...data: Global.TemplateData
) => {
    describe: {
        (
            title: string,
            suite: Global.EachTestFn<Global.BlockFn>,
            timeout?: number
        ): any;
        skip: any;
        only: any;
    };
    fdescribe: any;
    fit: any;
    it: {
        (
            title: string,
            test: Global.EachTestFn<Global.TestFn>,
            timeout?: number
        ): any;
        skip: any;
        only: any;
        concurrent: {
            (
                title: string,
                test: Global.EachTestFn<Global.TestFn>,
                timeout?: number
            ): any;
            only: any;
            skip: any;
        };
    };
    test: {
        (
            title: string,
            test: Global.EachTestFn<Global.TestFn>,
            timeout?: number
        ): any;
        skip: any;
        only: any;
        concurrent: {
            (
                title: string,
                test: Global.EachTestFn<Global.TestFn>,
                timeout?: number
            ): any;
            only: any;
            skip: any;
        };
    };
    xdescribe: any;
    xit: any;
    xtest: any;
};

Package Files (1)

build/index.d.ts

Dependencies (5)

Dev Dependencies (0)

No dev dependencies.

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this oneto 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-each.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/jest-each)

HTML

<a href="https://www.jsdocs.io/package/jest-each"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 1 year ago.
Package analyzed in 3083 ms.
Missing or incorrect documentation? Open an issue for this package.