Variable asyncIterableEmptyAssertion`Const`

asyncIterableEmptyAssertion: AssertionFunctionAsync<
    readonly [
        ZodUnion<
            readonly [
                ZodCustom<
                    AsyncIterable<unknown, any, any>,
                    AsyncIterable<unknown, any, any>,
                >,
                ZodCustom<
                    AsyncIterator<unknown, any, any>,
                    AsyncIterator<unknown, any, any>,
                >,
                ZodCustom<Iterable<unknown, any, any>, Iterable<unknown, any, any>>,
            ],
        >,
        "to be an empty iterable",
    ],
    (
        subject:
            | Iterable<unknown, any, any>
            | AsyncIterable<unknown, any, any>
            | AsyncIterator<unknown, any, any>,
    ) => Promise<{ message: string } | undefined>,
    readonly [
        ZodUnion<
            readonly [
                ZodCustom<
                    AsyncIterable<unknown, any, any>,
                    AsyncIterable<unknown, any, any>,
                >,
                ZodCustom<
                    AsyncIterator<unknown, any, any>,
                    AsyncIterator<unknown, any, any>,
                >,
                ZodCustom<Iterable<unknown, any, any>, Iterable<unknown, any, any>>,
            ],
        >,
        PhraseLiteralSlot<"to be an empty iterable">,
    ],
> = ...

Asserts that an async iterable yields nothing (is empty).

Remarks

Use 'not to be an empty iterable' or 'to yield at least', 1 for non-empty assertions.

Example

await expectAsync(emptyAsyncGen(), 'to be an empty iterable');

Bupkis Anchor

async-iterable-to-be-an-empty-iterable

Bupkis Assertion Category

iterable