lodash/test/pull-methods.spec.ts

import assert from 'node:assert';
import lodashStable from 'lodash';
import { _ } from './utils';

describe('pull methods', () => {
    lodashStable.each(['pull', 'pullAll', 'pullAllWith'], (methodName) => {
        const func = _[methodName],
            isPull = methodName === 'pull';

        function pull(array, values) {
            return isPull ? func.apply(undefined, [array].concat(values)) : func(array, values);
        }

        it(`\`_.${methodName}\` should modify and return the array`, () => {
            const array = [1, 2, 3],
                actual = pull(array, [1, 3]);

            assert.strictEqual(actual, array);
            assert.deepStrictEqual(array, [2]);
        });

        it(`\`_.${methodName}\` should preserve holes in arrays`, () => {
            const array = [1, 2, 3, 4];
            delete array[1];
            delete array[3];

            pull(array, [1]);
            assert.ok(!('0' in array));
            assert.ok(!('2' in array));
        });

        it(`\`_.${methodName}\` should treat holes as \`undefined\``, () => {
            const array = [1, 2, 3];
            delete array[1];

            pull(array, [undefined]);
            assert.deepStrictEqual(array, [1, 3]);
        });

        it(`\`_.${methodName}\` should match \`NaN\``, () => {
            const array = [1, NaN, 3, NaN];

            pull(array, [NaN]);
            assert.deepStrictEqual(array, [1, 3]);
        });
    });
});