Interface ExpectSyncProps<SyncAssertion, AsyncAssertion>

Properties of expect.

interface ExpectSyncProps<
    SyncAssertion extends AnySyncAssertion,
    AsyncAssertion extends AnyAsyncAssertion,
> {
    assertions: SpreadAssertions<SyncAssertion>;
    createAssertion: CreateAssertionFn;
    createAsyncAssertion: CreateAsyncAssertionFn;
    fail: FailFn;
    it: UnionToIntersection<
        SyncAssertion extends InvariantOf<U>
            ? ExpectItFunction<U["parts"]>
            : never,
    >;
    use: UseFn<SyncAssertion, AsyncAssertion>;
}

Type Parameters

SyncAssertion extends AnySyncAssertion
AsyncAssertion extends AnyAsyncAssertion

Hierarchy (View Summary)

BaseExpect<SyncAssertion, AsyncAssertion>
- ExpectSyncProps

Index

Properties

assertions createAssertion createAsyncAssertion fail it use

Properties

assertions

assertions: SpreadAssertions<SyncAssertion>

Tuple of all assertions available in this expect().

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

it

it: UnionToIntersection<
    SyncAssertion extends InvariantOf<U>
        ? ExpectItFunction<U["parts"]>
        : never,
>

use

use: UseFn<SyncAssertion, AsyncAssertion>

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