BUPKIS
    Preparing search index...

    Type Alias ExpectAsync<AsyncAssertion, SyncAssertion>

    The main asynchronous assertion function.

    Contains properties in ExpectAsyncProps.

    Type Parameters

    Type Declaration

    Properties available on asynchronous expect functions.

    This interface defines the additional properties and methods that are attached to async expect functions, extending the base expect functionality with async-specific features. These properties provide access to the underlying assertions and enable function composition through the use method.

    • assertions: SpreadAssertions<AsyncAssertion>

      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.

      Reason for failure

    • it: UnionToIntersection<
          AsyncAssertion extends InvariantOf<U>
              ? ExpectItFunctionAsync<U["parts"]>
              : never,
      >

      Factory type for creating async embeddable assertion executors.

      This type generates a union of all possible expectAsync.it function signatures based on the available asynchronous assertions. Each assertion contributes its own function signature to create embeddable async executors that can be used within async object patterns for complex validation scenarios.

      The resulting functions are designed to be used exclusively within async 'to satisfy' assertion contexts, where they provide type-safe pattern matching for nested object structures with Promise-based validation.

    • use: UseFn<SyncAssertion, AsyncAssertion>

      The type of a use() function.

    All asynchronous assertions available

    All synchronous assertions available; for use in ExpectAsyncProps.use only.