Function itCasesWithContext

Succinctly run many input / output tests for a pure function without repeating it boilerplate. Compatible with both Node.js's test runner and web-test-runner or other Mocha-style test runners.

Example

import {itCases, describe} from '@augment-vir/test';

function myFunctionToTest(a: number, b: number) {
    return a + b;
}

describe(myFunctionToTest.name, () => {
    itCases(myFunctionToTest, [
        {
            it: 'handles negative numbers',
            inputs: [
                -1,
                -2,
            ],
            expect: -3,
        },
        {
            it: 'handles 0',
            inputs: [
                0,
                0,
            ],
            expect: 0,
        },
        {
            it: 'adds',
            inputs: [
                3,
                5,
            ],
            expect: 8,
        },
    ]);
});

Package

@augment-vir/test

itCasesWithContext<const FunctionToTest extends BaseFunctionWithContext>(
    this: void,
    functionToTest: FunctionToTest,
    customAsserter: CustomOutputAsserter<NoInfer<FunctionToTest>>,
    testCases: readonly FunctionWithContextTestCase<NoInfer<FunctionToTest>>[],
): unknown[]

Succinctly run many input / output tests for a pure function without repeating it boilerplate. Compatible with both Node.js's test runner and web-test-runner or other Mocha-style test runners.

Type Parameters

const FunctionToTest extends BaseFunctionWithContext

Parameters

this: void
functionToTest: FunctionToTest
customAsserter: CustomOutputAsserter<NoInfer<FunctionToTest>>
testCases: readonly FunctionWithContextTestCase<NoInfer<FunctionToTest>>[]

Returns unknown[]

Example

import {itCases, describe} from '@augment-vir/test';

function myFunctionToTest(a: number, b: number) {
    return a + b;
}

describe(myFunctionToTest.name, () => {
    itCases(myFunctionToTest, [
        {
            it: 'handles negative numbers',
            inputs: [
                -1,
                -2,
            ],
            expect: -3,
        },
        {
            it: 'handles 0',
            inputs: [
                0,
                0,
            ],
            expect: 0,
        },
        {
            it: 'adds',
            inputs: [
                3,
                5,
            ],
            expect: 8,
        },
    ]);
});

Package

@augment-vir/test

itCasesWithContext<const FunctionToTest extends BaseFunctionWithContext>(
    this: void,
    functionToTest: FunctionToTest,
    testCases: readonly FunctionWithContextTestCase<NoInfer<FunctionToTest>>[],
): unknown[]

Succinctly run many input / output tests for a pure function without repeating it boilerplate. Compatible with both Node.js's test runner and web-test-runner or other Mocha-style test runners.

Type Parameters

const FunctionToTest extends BaseFunctionWithContext

Parameters

this: void
functionToTest: FunctionToTest
testCases: readonly FunctionWithContextTestCase<NoInfer<FunctionToTest>>[]

Returns unknown[]

Example

import {itCases, describe} from '@augment-vir/test';

function myFunctionToTest(a: number, b: number) {
    return a + b;
}

describe(myFunctionToTest.name, () => {
    itCases(myFunctionToTest, [
        {
            it: 'handles negative numbers',
            inputs: [
                -1,
                -2,
            ],
            expect: -3,
        },
        {
            it: 'handles 0',
            inputs: [
                0,
                0,
            ],
            expect: 0,
        },
        {
            it: 'adds',
            inputs: [
                3,
                5,
            ],
            expect: 8,
        },
    ]);
});

Package

@augment-vir/test

Function itCasesWithContext

Example

Package

Type Parameters

Parameters

Returns unknown[]

Example

Package

Type Parameters

Parameters

Returns unknown[]

Example

Package

Settings