Interface ExpectSyncProps<SyncAssertions, AsyncAssertions>

Properties of expect.

interface ExpectSyncProps<
    SyncAssertions extends AnySyncAssertions,
    AsyncAssertions extends AnyAsyncAssertions,
> {
    assertions: SyncAssertions;
    use: UseFn<SyncAssertions, AsyncAssertions>;
    createAssertion: CreateAssertionFn;
    createAsyncAssertion: CreateAsyncAssertionFn;
    fail: FailFn;
}

Type Parameters

SyncAssertions extends AnySyncAssertions
AsyncAssertions extends AnyAsyncAssertions

Hierarchy (View Summary)

BaseExpect
- ExpectSyncProps

Index

Properties

assertions use createAssertion createAsyncAssertion fail

Properties

assertions

assertions: SyncAssertions

Tuple of all assertions available in this expect().

use

use: UseFn<SyncAssertions, AsyncAssertions>

Function to add more assertions to this expect(), returning a new expect() and expectAsync() pair with the combined assertions.

createAssertion

createAssertion: CreateAssertionFn

Creates a new synchronous assertion.

createAsyncAssertion

createAsyncAssertion: CreateAsyncAssertionFn

Creates a new asynchronous assertion.

fail

fail: FailFn

Fails immediately with optional reason.

Param: reason

Reason for failure

Throws