Interface Bupkis<BaseSyncAssertion, BaseAsyncAssertion, ExtendedSyncAssertion, ExtendedAsyncAssertion>

The main API as returned by a UseFn.

interface Bupkis<
    BaseSyncAssertion extends AnySyncAssertion,
    BaseAsyncAssertion extends AnyAsyncAssertion,
    ExtendedSyncAssertion extends AnySyncAssertion,
    ExtendedAsyncAssertion extends AnyAsyncAssertion,
> {
    expect: Expect<
        BaseSyncAssertion
        | ExtendedSyncAssertion,
        BaseAsyncAssertion | ExtendedAsyncAssertion,
    >;
    expectAsync: ExpectAsync<
        BaseAsyncAssertion
        | ExtendedAsyncAssertion,
        BaseSyncAssertion | ExtendedSyncAssertion,
    >;
    use: UseFn<
        BaseSyncAssertion
        | ExtendedSyncAssertion,
        BaseAsyncAssertion | ExtendedAsyncAssertion,
    >;
}

Type Parameters

BaseSyncAssertion extends AnySyncAssertion
Base set of synchronous Assertions; will be the builtin sync assertions, at minimum)
BaseAsyncAssertion extends AnyAsyncAssertion
Base set of asynchronous Assertions; will be the builtin async assertions, at minimum)
ExtendedSyncAssertion extends AnySyncAssertion
Synchronous assertions extracted from MixedAssertions
ExtendedAsyncAssertion extends AnyAsyncAssertion
Asynchronous assertions extracted from MixedAssertions

Index

Properties

expect expectAsync use

Properties

expect

expect: Expect<
    BaseSyncAssertion
    | ExtendedSyncAssertion,
    BaseAsyncAssertion | ExtendedAsyncAssertion,
>

A new Expect function which handles ExtendedSyncAssertion and BaseSyncAssertion

expectAsync

expectAsync: ExpectAsync<
    BaseAsyncAssertion
    | ExtendedAsyncAssertion,
    BaseSyncAssertion | ExtendedSyncAssertion,
>

A new ExpectAsync function which handles ExtendedAsyncAssertion and BaseAsyncAssertion

use

use: UseFn<
    BaseSyncAssertion
    | ExtendedSyncAssertion,
    BaseAsyncAssertion | ExtendedAsyncAssertion,
>

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]);