array-pull-all-with-glob^4.12.72

pullAllWithGlob - like _.pullAll but pulling stronger, with globs

Install globally, via npm

npm i array-pull-all-with-glob

The default is exported, so instead of "pullAllWithGlob" below, you can name the consumed function however you want.

Consume via a require():

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

or as an ES Module:

import pullAllWithGlob 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">

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

const pullAllWithGlob = arrayPullAllWithGlob;

This pullAllWithGlob is your main function. See its API in the main section.

Trivia

This program has 50 assertions in its unit tests. That's less than all unit test assertions' median (52) and less than geometric mean (71).

In monorepo, 2 other packages consume this package.

§ Quick Take

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

assert.deepEqual(
  pullAllWithGlob(
    [
      "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

pullAllWithGlob(sourceArray, removeThese, [opts]);

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

§ API - Input

Input argument	Type	Obligatory?	Description
`sourceArray`	Array	yes	Source array of 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.