matching-iterator v2.1.3

matching-iterator

glob style matching on iterables

usage

import { matcher } from "matching-iterator";

for await (const r of matcher([
    { name: "a" },{ name: "b" }], "a*", { name: "name" })) {
  console.log(r);
}

API

Table of Contents

• matcher
  • Parameters
• asyncMatcher
  • Parameters
• compile
  • Parameters

matcher

Match entries against glob pattern.

Parameters

• entries Iterable<(string | Object)> input
• patterns (Array[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | string | undefined) filter to apply

• options Object (optional, default {})

  • options.name string? name of the name attribute
  • options.caseSensitive boolean? defaults to true

Returns Iterable<(string | Object)> filtered entries

asyncMatcher

Match entries against glob pattern.

Parameters

• entries Iterable<(string | Object)> input
• patterns (Array[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | string | undefined) filter to apply

• options Object (optional, default {})

  • options.name string? name of the name attribute
  • options.caseSensitive boolean? defaults to true

Returns AsyncGenerator<(string | Object)> filtered entries

compile

• See: https://stackoverflow.com/questions/869809/combine-regexp

Parameters

• patterns (Array[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | string)
• options Object

Returns any globs copiled into regex

install

With npm do:

npm install matching-iterator

license

BSD-2-Clause