collectype / factory/objects/objectKeyMembership / objectKeyMembershipFactory
objectKeyMembershipFactory<
T,C>(ctx,oper): <K>(field,keys) =>C
Defined in: factory/objects/objectKeyMembership.ts:40
Creates a predicate filter for object key membership using PredicType.object.keyMembership.
T
The item type in the collection.
C extends Wherable<T, C>
The Wherable context type (must extend Wherable<T, C>).
C
The context (usually a collection) supporting the where method.
ObjectKeyMembershipOper
The object key membership operation (e.g., ‘in’, ‘notIn’, etc.).
Returns a function that takes a field (of type object on T) and a list of keys, and applies the object key membership predicate to filter the context.
<
K>(field,keys):C
K extends string | number | symbol
K
(string | symbol)[]
C
// Example: Composing an object key membership filter as a property, homogeneous model
import { BaseFunctions } from 'collectype';
import { objectKeyMembershipFactory } from 'collectype';
type Person = { name: string; meta: { country: string; city?: string } };
class PersonFunctions extends BaseFunctions<Person> {
objectKeyIn = objectKeyMembershipFactory<Person, this>(this, 'in');
}
// Usage:
const people: Person[] = [
{ name: 'Alice', meta: { country: 'FR', city: 'Paris' } },
{ name: 'Bob', meta: { country: 'US' } }
];
const fn = new PersonFunctions(people);
const filtered = fn.objectKeyIn('meta', ['city', 'country', 'zip']);
// filtered contains the items where 'meta' has the key 'city'