predictype / predicates/objects / objectKeyMembership
objectKeyMembership(
source,oper,keys):boolean
Defined in: predicates/objects/objectKeyMembership.ts:27
Checks if a key is (or is not) in a list of possible keys using the specified operation.
object
The object to check.
The membership operation to perform (e.g. ‘in’, ‘not_in’).
(string | symbol)[]
The array of possible keys.
boolean
True if the membership check is valid according to the operator, otherwise false.
If the operation is not recognized or keys is missing.
const idSymbol = Symbol('id');
const source = { name: 'Ada', [idSymbol]: 1 };
const keysA = ['name', 'missing'];
const keysB = ['missing'];
objectKeyMembership(source, 'in', keysA); // true
objectKeyMembership(source, 'not_in', keysB); // true
Supported Operators: