Variable objectKeysSatisfyAssertion`Const` `Function`

objectKeysSatisfyAssertion: AssertionFunctionSync<
    readonly [
        ZodCustom<
            Record<PropertyKey, unknown>
            | ((...args: any[]) => any),
            Record<PropertyKey, unknown> | ((...args: any[]) => any),
        >,
        readonly [
            "to have keys satisfying",
            "to have props satisfying",
            "to have properties satisfying",
            "to have fields satisfying",
        ],
        ZodUnknown,
    ],
    (
        subject: Record<PropertyKey, unknown> | ((...args: any[]) => any),
        expected: unknown,
    ) => { message: string } | undefined,
    readonly [
        ZodCustom<
            Record<PropertyKey, unknown>
            | ((...args: any[]) => any),
            Record<PropertyKey, unknown> | ((...args: any[]) => any),
        >,
        PhraseLiteralChoiceSlot<
            readonly [
                "to have keys satisfying",
                "to have props satisfying",
                "to have properties satisfying",
                "to have fields satisfying",
            ],
        >,
        ZodUnknown,
    ],
> = ...

Asserts that ALL own enumerable string keys of a non-collection object individually satisfy the expected shape.

Uses partial/satisfy semantics — every key must match. Empty objects pass vacuously.

Remarks

Only considers own enumerable string keys (equivalent to Object.keys()). Symbol keys and non-enumerable keys are not checked.

Example

expect({ foo: 1, bar: 2 }, 'to have keys satisfying', z.string()); // passes
expect({ foo: 1, bar: 2 }, 'to have props satisfying', /^[a-z]+$/); // alias
expect({ foo: 1, bar: 2 }, 'to have fields satisfying', /^[a-z]+$/); // alias
expect({ FOO: 1 }, 'to have keys satisfying', /^[a-z]+$/); // fails

Bupkis Anchor

object-to-have-keys-satisfying-any

Bupkis Assertion Category

object