@palmares/tests/dist/src/functions.d.ts

This defines a default test framework testing stuff inside of the framework

import type { TestAdapter } from './adapter';
import type { Expect } from './expect';
/**
 * Describe a test suite to run tests in
 *
 * @example
 * ```typescript
 * describe('Test suite', ({ test }) => {
 *   test('Test', async ({ expect }) => {
 *     expect(1).toBe(1);
 *   });
 * });
 * ```
 *
 * @param descriptionName The name of the test suite
 * @param callback The callback to run the tests, the callback will for convenience receive the
 * `test` function to run tests and the `custom` object that was passed to the test adapter
 */
export declare function describe<TTestAdapter extends TestAdapter = TestAdapter>(descriptionName: string, callback: (args: {
    test: typeof test<TTestAdapter>;
    beforeEach: typeof beforeEach<TTestAdapter>;
    afterEach: typeof afterEach<TTestAdapter>;
} & {
    custom: Awaited<ReturnType<TTestAdapter['getCustomProps']>>;
}) => void, customArgs?: Parameters<TTestAdapter['functions']['getDescribe']>[2]): void;
/**
 * Run a test it can be either called inside a `describe` or on its own
 *
 * @example
 * ```typescript
 * test('Test', async ({ expect }) => {
 *  expect(1).toBe(1);
 * });
 * ```
 *
 * @param testName The name of the test
 * @param callback The callback to run the test, the callback will for convenience receive the
 * `expect` function to run assertions and the `custom` object that was passed to the test adapter
 */
export declare function test<TTestAdapter extends TestAdapter = TestAdapter>(testName: string, callback: (args: {
    expect: typeof expect;
} & {
    custom: Awaited<ReturnType<TTestAdapter['getCustomProps']>>;
}) => Promise<void> | void, customArgs?: Parameters<TTestAdapter['functions']['getTest']>[2]): void;
/**
 * Run a function before each test.
 *
 * @example
 * ```typescript
 * beforeEach(({ custom }) => {
 *   db.init();
 * });
 * ```
 *
 * @param callback The callback to run before each test, the callback will for convenience receive the
 * `custom` object that was passed to the test adapter
 */
export declare function beforeEach<TTestAdapter extends TestAdapter = TestAdapter>(callback: (args: {
    custom: Awaited<ReturnType<TTestAdapter['getCustomProps']>>;
}) => Promise<void> | void, customArgs?: Parameters<TTestAdapter['functions']['getBeforeEach']>[2]): void;
/**
 * Run a function after each test.
 *
 * @example
 *  ```typescript
 * afterEach(({ custom }) => {
 *   db.flush();
 * });
 * ```
 *
 * @param callback - The callback to run after each test, the callback will for convenience receive the
 * `custom` object that was passed to the test adapter
 */
export declare function afterEach<TTestAdapter extends TestAdapter = TestAdapter>(callback: (args: {
    custom: Awaited<ReturnType<TTestAdapter['getCustomProps']>>;
}) => Promise<void> | void, customArgs?: Parameters<TTestAdapter['functions']['getAfterEach']>[2]): void;
/**
 * Run a function before all tests.
 *
 * @example
 * ```typescript
 * beforeAll(({ custom }) => {
 *   db.seed();
 * });
 * ```
 *
 * @param callback - The callback to run before all tests, the callback will for convenience receive the
 * `custom` object that was passed to the test adapter
 */
export declare function beforeAll<TTestAdapter extends TestAdapter = TestAdapter>(callback: (args: {
    custom: Awaited<ReturnType<TTestAdapter['getCustomProps']>>;
}) => Promise<void> | void, customArgs?: Parameters<TTestAdapter['functions']['getBeforeAll']>[2]): void;
/**
 * Run a function after all tests.
 *
 * @example
 * ```typescript
 * afterAll(({ custom }) => {
 *   db.flush();
 * });
 * ```
 *
 * @param callback - The callback to run after all tests, the callback will for convenience receive the
 * `custom` object that was passed to the test adapter
 */
export declare function afterAll<TTestAdapter extends TestAdapter = TestAdapter>(callback: (args: {
    custom: Awaited<ReturnType<TTestAdapter['getCustomProps']>>;
}) => Promise<void> | void, customArgs?: Parameters<TTestAdapter['functions']['getAfterAll']>[2]): void;
export declare function expect<TValue, TTestAdapter extends TestAdapter = TestAdapter>(value: TValue): Expect<TValue, TTestAdapter, false>;
//# sourceMappingURL=functions.d.ts.map