predictype

predictype v0.8.1


predictype / predicates/sets / setArrayMembership

Function: setArrayMembership()

setArrayMembership<T>(source, oper, target): boolean

Defined in: predicates/sets/setArrayMembership.ts:27

Checks membership conditions for multiple elements in a set using the specified operation.

Type Parameters

T

T

Parameters

source

Set<T>

The set to check.

oper

SetArrayMembershipOper

The membership operation to perform (e.g. ‘contains_all’, ‘contains_any’).

target

T[]

The array of values to check for membership.

Returns

boolean

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

Throws

If the operation is not recognized.

Example

const s = new Set([1, 2, 3]);
const values = [2, 4];

setArrayMembership(s, 'contains_any', values); // true (contains 2)
setArrayMembership(s, 'contains_all', values); // false (missing 4)
setArrayMembership(s, 'excludes_all', [5, 6]); // true (excludes both)

Remarks

Supported Operators: