Variable iterableYieldsAssertionConst

iterableYieldsAssertion: AssertionFunctionSync<
    readonly [
        ZodUnion<
            readonly [
                ZodCustom<Iterable<unknown, any, any>, Iterable<unknown, any, any>>,
                ZodCustom<Iterator<unknown, any, any>, Iterator<unknown, any, any>>,
            ],
        >,
        readonly ["to yield", "to emit", "to yield value satisfying"],
        ZodUnknown,
    ],
    (
        subject: Iterator<unknown, any, any> | Iterable<unknown, any, any>,
        expected: unknown,
    ) => { message: string } | undefined,
    readonly [
        ZodUnion<
            readonly [
                ZodCustom<Iterable<unknown, any, any>, Iterable<unknown, any, any>>,
                ZodCustom<Iterator<unknown, any, any>, Iterator<unknown, any, any>>,
            ],
        >,
        PhraseLiteralChoiceSlot<
            readonly ["to yield", "to emit", "to yield value satisfying"],
        >,
        ZodUnknown,
    ],
> = ...

expect([{ a: 1, b: 2 }], 'to yield', { a: 1 }); // passes (partial match)
expect([1, 2, 3], 'to emit', 2); // passes
expect(myGenerator(), 'to yield value satisfying', { name: 'test' }); // passes
Copy