Interface Bupkis<BaseSyncAssertions, BaseAsyncAssertions, ExtendedSyncAssertions, ExtendedAsyncAssertions>

The main API as returned by a UseFn.

interface Bupkis<
    BaseSyncAssertions extends AnySyncAssertions,
    BaseAsyncAssertions extends AnyAsyncAssertions,
    ExtendedSyncAssertions extends readonly AnySyncAssertion[] = readonly [],
    ExtendedAsyncAssertions extends readonly AnyAsyncAssertion[] = readonly [],
> {
    expect: Expect<
        readonly [BaseSyncAssertions, ExtendedSyncAssertions],
        readonly [BaseAsyncAssertions, ExtendedAsyncAssertions],
    >;
    expectAsync: ExpectAsync<
        readonly [BaseAsyncAssertions, ExtendedAsyncAssertions],
        readonly [BaseSyncAssertions, ExtendedSyncAssertions],
    >;
    use: UseFn<
        readonly [BaseSyncAssertions, ExtendedSyncAssertions],
        readonly [BaseAsyncAssertions, ExtendedAsyncAssertions],
    >;
}

Type Parameters

BaseSyncAssertions extends AnySyncAssertions
Base set of synchronous Assertions; will be the builtin sync assertions, at minimum)
BaseAsyncAssertions extends AnyAsyncAssertions
Base set of asynchronous Assertions; will be the builtin async assertions, at minimum)
ExtendedSyncAssertions extends readonly AnySyncAssertion[] = readonly []
Synchronous assertions extracted from MixedAssertions
ExtendedAsyncAssertions extends readonly AnyAsyncAssertion[] = readonly []
Asynchronous assertions extracted from MixedAssertions

Index

Properties

expect expectAsync use

Properties

expect

expect: Expect<
readonly [BaseSyncAssertions, ExtendedSyncAssertions],
readonly [BaseAsyncAssertions, ExtendedAsyncAssertions],
>

A new Expect function which handles ExtendedSyncAssertions and BaseSyncAssertions

expectAsync

expectAsync: ExpectAsync<
readonly [BaseAsyncAssertions, ExtendedAsyncAssertions],
readonly [BaseSyncAssertions, ExtendedSyncAssertions],
>

A new ExpectAsync function which handles ExtendedAsyncAssertions and BaseAsyncAssertions

use

use: UseFn<
readonly [BaseSyncAssertions, ExtendedSyncAssertions],
readonly [BaseAsyncAssertions, ExtendedAsyncAssertions],
>

For composing arrays of assertions, one after another.

The only chainable API in Bupkis.

Since

0.1.0

Example

const { expect } = use([...someAssertions]).use([...otherAssertions]);