Function without

without<V>(
    sourceArray: readonly V[] | V[],
    toRemove: V | V[],
    comparer?: IsEqual<V>,
): V[]

Returns an array with value(s) omitted. If value is not found, result will be a copy of input. Value checking is completed via the provided comparer function. By default checking whether a === b. To compare based on value, use the isEqualValueDefault comparer.

Type Parameters

V
Type of array items

Parameters

sourceArray: readonly V[] | V[]
Source array
toRemove: V | V[]
Value(s) to remove
comparer: IsEqual<V> = isEqualDefault
Comparison function. If not provided Util.isEqualDefault is used, which compares using ===

Returns V[]

Copy of array without value.

Example

import { Arrays } from 'https://unpkg.com/ixfx/dist/data.js';

const data = [100, 20, 40];
const filtered = Arrays.without(data, 20); // [100, 40]

Example: Using value-based comparison

import { Arrays } from 'https://unpkg.com/ixfx/dist/data.js';

const data = [{name: `Alice`}, {name:`Sam`}];

// This wouldn't work as expected, because the default comparer uses instance,
// not value:
Arrays.without(data, {name: `Alice`});

// So instead we can use a value comparer:
Arrays.without(data, {name:`Alice`}, isEqualValueDefault);

Example: Use a function

import { Arrays } from 'https://unpkg.com/ixfx/dist/data.js';

const data = [{name: `Alice`}, {name:`Sam`}];
Arrays.without(data, {name:`ALICE`}, (a, b) => {
 return (a.name.toLowerCase() === b.name.toLowerCase());
});

Consider remove to remove an item by index.