predictype

predictype v0.8.1

---

predictype / predicates/objects/objectKeys / objectKeysCompare

Function: objectKeysCompare()

objectKeysCompare(source, oper, keys): boolean

Defined in: predicates/objects/objectKeys.ts:24

Checks object keys for key-comparison operations (CONTAINS_, LACKS_, EQUALS_, etc.).

Parameters

source

object

The object to check.

oper

ObjectKeysOper

The key operation to perform (e.g. ‘contains_all_keys’, ‘lacks_all_keys’, ‘equals_keys’, …).

keys

The array of keys to check (string[]

symbol[]).

string[]

symbol[]

Returns

boolean

True if the key check is valid according to the operator, otherwise false.

Throws

If the operation is not recognized or keys is missing.

Remarks

Supported Operators:

• CONTAINS_ALL_KEYS: Object contains all the given keys
• CONTAINS_ANY_KEY: Object contains at least one of the keys
• CONTAINS_ONLY_KEYS: Object contains only the given keys
• CONTAINS_SYMBOL_KEYS: Object contains at least one symbol key
• EQUALS_KEYS: Object keys equal the given keys
• LACKS_ALL_KEYS: Object lacks all the given keys
• ONLY_KEYS: All object keys are in the given set
• STRICT_EQUALS_KEYS: Object keys strictly equal the given keys

This site is open source. Improve this page.