Variable objectKeysMatchAssertion`Const` `Function`

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

Asserts that ALL own enumerable string keys of a non-collection object match a regular expression.

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 matching', /^[a-z]+$/); // passes
expect({ foo: 1, bar: 2 }, 'to have props matching', /^[a-z]+$/); // alias
expect({ foo: 1, bar: 2 }, 'to have fields matching', /^[a-z]+$/); // alias
expect({ foo: 1, Bar: 2 }, 'to have keys matching', /^[a-z]+$/); // fails
expect({}, 'to have keys matching', /anything/); // passes (vacuous)

Bupkis Anchor

object-to-have-keys-matching-regexp

Bupkis Assertion Category

object