https://github.com/arlac77/matching-iterator

glob style matching on iterables
https://github.com/arlac77/matching-iterator

Last synced: about 1 year ago
JSON representation

glob style matching on iterables

• Host: GitHub
• URL: https://github.com/arlac77/matching-iterator
• Owner: arlac77
• License: 0bsd
• Created: 2020-05-30T23:16:53.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2025-03-19T00:27:56.000Z (about 1 year ago)
• Last Synced: 2025-03-25T06:01:39.321Z (about 1 year ago)
• Language: JavaScript
• Size: 1.75 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![npm](https://img.shields.io/npm/v/matching-iterator.svg)](https://www.npmjs.com/package/matching-iterator)

[![License](https://img.shields.io/badge/License-0BSD-blue.svg)](https://spdx.org/licenses/0BSD.html)

[![Typed with TypeScript](https://flat.badgen.net/badge/icon/Typed?icon=typescript\&label\&labelColor=blue\&color=555555)](https://typescriptlang.org)

[![bundlejs](https://deno.bundlejs.com/?q=matching-iterator\&badge=detailed)](https://bundlejs.com/?q=matching-iterator)

[![downloads](http://img.shields.io/npm/dm/matching-iterator.svg?style=flat-square)](https://npmjs.org/package/matching-iterator)

[![GitHub Issues](https://img.shields.io/github/issues/arlac77/matching-iterator.svg?style=flat-square)](https://github.com/arlac77/matching-iterator/issues)

[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Farlac77%2Fmatching-iterator%2Fbadge\&style=flat)](https://actions-badge.atrox.dev/arlac77/matching-iterator/goto)

[![Styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

[![Known Vulnerabilities](https://snyk.io/test/github/arlac77/matching-iterator/badge.svg)](https://snyk.io/test/github/arlac77/matching-iterator)

[![Coverage Status](https://coveralls.io/repos/arlac77/matching-iterator/badge.svg)](https://coveralls.io/github/arlac77/matching-iterator)

# matching-iterator

glob style matching on iterables

# usage

```js

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](#matcher)

    *   [Parameters](#parameters)

*   [asyncMatcher](#asyncmatcher)

    *   [Parameters](#parameters-1)

*   [compile](#compile)

    *   [Parameters](#parameters-2)

## matcher

Match entries against glob pattern.

### Parameters

*   `entries` **Iterable<([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object))>** input

*   `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** filter to apply

*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**  (optional, default `{}`)

    *   `options.name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** name of the name attribute

    *   `options.caseSensitive` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** defaults to true

Returns **Iterable<([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object))>** filtered entries

## asyncMatcher

Match entries against glob pattern.

### Parameters

*   `entries` **Iterable<([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object))>** input

*   `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** filter to apply

*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**  (optional, default `{}`)

    *   `options.name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** name of the name attribute

    *   `options.caseSensitive` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** defaults to true

Returns **AsyncGenerator<([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object))>** filtered entries

## compile

*   **See**: 

### Parameters

*   `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))** 

*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 

Returns **any** globs copiled into regex

# install

With [npm](http://npmjs.org) do:

```shell

npm install matching-iterator

```

# license

BSD-2-Clause