array-pull-all-with-glob^5.0.14

Like _.pullAll but with globs (wildcards)

Install via npm

npm i array-pull-all-with-glob

Consume via a require():

const { pull } = require("array-pull-all-with-glob");

or as an ES Module:

import { pull } from "array-pull-all-with-glob";

Install as a script, via CDN

Put this in your HTML:

<script src="https://cdn.jsdelivr.net/npm/array-pull-all-with-glob/dist/array-pull-all-with-glob.umd.js"></script>

Then, you’ll get a global variable arrayPullAllWithGlob in your Global object and you consume it like this:

const { pull } = arrayPullAllWithGlob;

Trivia

This program has 35 assertions in its unit tests. That's less than all unit test assertions' median (44) and less than geometric mean (72).

In monorepo, 2 other packages consume this package.

§ Quick Take

import { strict as assert } from "assert";
import { pull } from "array-pull-all-with-glob";

assert.deepEqual(
  pull(
    [
      "keep_me",
      "name-1",
      "name-2",
      "name-jhkgdhgkhdfghdkghfdk",
    ],
    ["name-*"]
  ),
  ["keep_me"]
);

⬆ back to top

§ Purpose

This program removes strings from array if they match a glob pattern. It's like Lodash's _.pullAll except with globby on top.

For example, we use it in email-comb to whitelist CSS class/id names.

⬆ back to top

§ API

pull(
  sourceArray,
  removeThese,
  [opts]
)

In other words, it's a function which takes three input arguments, third-one being optional (marked by square brackets).

⬆ back to top

§ API - Input

Input argument	Type	Obligatory?	Description
`sourceArray`	Array of zero or more strings	yes	Source array of zero or more strings
`removeThese`	Array of zero or more strings or a string	yes	Array of zero or more strings or a single string to be removed from the source array
`otps`	Plain object	no	An Optional Options Object. See its API below.