Variable promiseRejectWithErrorSatisfyingAssertion`Const`

promiseRejectWithErrorSatisfyingAssertion: AssertionFunctionAsync<
    readonly [
        ZodCustom<PromiseLike<unknown>, PromiseLike<unknown>>,
        readonly [
            "to reject with error satisfying",
            "to be rejected with error satisfying",
        ],
        ZodUnknown,
    ],
    (
        subject: PromiseLike<unknown>,
        param: unknown,
    ) => Promise<
        | { message: string; schema?: undefined; subject?: undefined }
        | {
            message?: undefined;
            schema: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>;
            subject: {} | null;
        },
    >,
    readonly [
        ZodCustom<PromiseLike<unknown>, PromiseLike<unknown>>,
        PhraseLiteralChoiceSlot<
            readonly [
                "to reject with error satisfying",
                "to be rejected with error satisfying",
            ],
        >,
        ZodUnknown,
    ],
> = ...

Assertion for testing if a Promise rejects with an error satisfying specific criteria.

Example

await expectAsync(
  Promise.reject(new Error('oops')),
  'to reject with error satisfying',
  'oops',
); // passes
await expectAsync(
  Promise.reject(new Error('fail')),
  'to reject with error satisfying',
  /error/i,
); // passes
await expectAsync(
  Promise.reject(new Error('oops')),
  'to reject with error satisfying',
  { message: 'oops' },
); // passes

Variable promiseRejectWithErrorSatisfyingAssertionConst

Example

Settings

Variable promiseRejectWithErrorSatisfyingAssertion`Const`