Variable promiseRejectAssertion`Const`

promiseRejectAssertion: AssertionFunctionAsync<
    readonly [
        ZodCustom<PromiseLike<unknown>, PromiseLike<unknown>>,
        readonly ["to reject", "to be rejected"],
    ],
    (subject: PromiseLike<unknown>) => Promise<{ message: string } | undefined>,
    readonly [
        ZodCustom<PromiseLike<unknown>, PromiseLike<unknown>>,
        PhraseLiteralChoiceSlot<readonly ["to reject", "to be rejected"]>,
    ],
> = ...

Assertion for testing if a Promise is rejected.

Example

await expectAsync(Promise.reject('error'), 'to reject'); // passes
await expectAsync(Promise.resolve('success'), 'to reject'); // fails