Function test

test(testFn: (tc: TestCase) => void, settings?: Partial<Settings>): void

Run a property-based test.

If your property is async, see testAsync instead.

Parameters

testFn: (tc: TestCase) => void
Optionalsettings: Partial<Settings>

Returns void

Example

import { test } from 'vitest';
import * as hegel from 'hegel';
import * as gs from 'hegel/generators';

test('addition is commutative', () =>
  hegel.test((tc) => {
    const x = tc.draw(gs.integers());
    const y = tc.draw(gs.integers());
    expect(x + y).toBe(y + x);
  }),
);