Type Alias Expect<SyncAssertion, AsyncAssertion>

The main synchronous assertion function.

Contains properties in ExpectSyncProps.

SyncAssertion extends AnySyncAssertion = InvariantBuiltinSyncAssertions
All synchronous assertions available
AsyncAssertion extends AnyAsyncAssertion = InvariantBuiltinAsyncAssertions
All asynchronous assertions available; for use in ExpectSyncProps.use only.

Properties of expect.

assertions: SpreadAssertions<SyncAssertion>

Tuple of all assertions available in this expect().
createAssertion: CreateAssertionFn

Creates a new synchronous assertion.
createAsyncAssertion: CreateAsyncAssertionFn

Creates a new asynchronous assertion.
fail: FailFn

Fails immediately with optional reason.

Param: reason
Reason for failure

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

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