https://github.com/bartozzz/wildcard-named

A small and easy-to-use utility module for matching strings using named and/or unnamed wildcards for JavaScript.
https://github.com/bartozzz/wildcard-named

match pattern pattern-matching regex regex-util string-matching wildcard

Last synced: about 2 months ago
JSON representation

A small and easy-to-use utility module for matching strings using named and/or unnamed wildcards for JavaScript.

• Host: GitHub
• URL: https://github.com/bartozzz/wildcard-named
• Owner: Bartozzz
• License: mit
• Created: 2016-05-24T20:42:22.000Z (over 8 years ago)
• Default Branch: development
• Last Pushed: 2023-01-07T03:55:55.000Z (almost 2 years ago)
• Last Synced: 2024-05-02T06:14:05.573Z (8 months ago)
• Topics: match, pattern, pattern-matching, regex, regex-util, string-matching, wildcard
• Language: JavaScript
• Homepage:
• Size: 1.15 MB
• Stars: 8
• Watchers: 3
• Forks: 2
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  
wildcard-named


[![Default CI/CD](https://github.com/Bartozzz/wildcard-named/workflows/Default%20CI/CD/badge.svg)](https://github.com/Bartozzz/wildcard-named/actions)

[![Known Vulnerabilities](https://snyk.io/test/github/Bartozzz/wildcard-named/badge.svg?targetFile=package.json)](https://snyk.io/test/github/Bartozzz/wildcard-named?targetFile=package.json)

[![npm package size](https://img.badgesize.io/Bartozzz/wildcard-named/master/dist/index.js?compression=gzip)](https://www.npmjs.com/package/wildcard-named)

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

[![npm dependency Status](https://david-dm.org/Bartozzz/wildcard-named.svg)](https://www.npmjs.com/package/wildcard-named)

[![npm downloads](https://img.shields.io/npm/dt/wildcard-named.svg)](https://www.npmjs.com/package/wildcard-named)




A small and easy-to-use utility module for matching strings using named and/or unnamed wildcards for JavaScript.



## Installation

```bash

$ npm install wildcard-named

```

## Usage

```javascript

import wildcard from "wildcard-named";

```

### Basic example

```javascript

import wildcard from "wildcard-named";

wildcard("//blog.com/page/14", "//blog.com/page/[digit:page]");

// { 'page': '14' }

wildcard("abc-123:d2f", "[digit:a]-[alpah:]:[alnum:c]");

// { 'a': 'abc', '0': '123', 'c': 'd2f' }

```

### Unnamed wildcards

```javascript

import wildcard from "wildcard-named";

wildcard("a-b-c", "[alpah:]-[alpah:]-[alpah:]");

// { '0': 'a', '1': 'b', '2': 'c' }

```

### Unmatched wildcards

When the pattern cannot be resolved, it will return `undefined`.

```javascript

import wildcard from "wildcard-named";

wildcard("a-b-c", "[alpah:]");

// undefined

```

### Wildcards

You can add your own filters using the `.addFilter(filter, regex)` function, like this:

```javascript

import wildcard, { addFilter } from "wildcard-named";

addFilter("testA", "(.*?)");

addFilter("testB", "([0-9])");

wildcard("match-1", "[testA:a]-[testB:b]");

// { 'a': 'match', 'b': '1' }

```

All registered filters are stored in a [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) at `wildcard.filters`.

#### Predefined wildcards

| Filter   | Regex                                                              | Description                                                         |

| -------- | ------------------------------------------------------------------ | ------------------------------------------------------------------- |

| `digit`  | `([0-9]+)`                                                         | Digits.                                                             |

| `alnum`  | `([0-9A-Za-z]+)`                                                   | Alphanumeric characters.                                            |

| `alpha`  | `([A-Za-z]+)`                                                      | Alphabetic characters.                                              |

| `xdigit` | `([0-9A-Fa-f]+)`                                                   | Hexadecimal digits.                                                 |

| `punct`  | `([\u2000-\u206F\u2E00-\u2E7F\'!"#$%&()*+,\-./:;<=>?@\[\]^_{}~]+)` | Punctuation (with symbols).                                         |

| `print`  | `([\x20-\x7e]*)`                                                   | Visible characters and spaces (anything except control characters). |

| `upper`  | `([A-Z]+)`                                                         | Uppercase letters.                                                  |

| `lower`  | `([a-z]+)`                                                         | Lowercase letters.                                                  |

| `all`    | `(.*?)`                                                            | Everything.                                                         |

| `word`   | `([A-Za-z0-9_]+)`                                                  | Word characters (letters, numbers and underscores).                 |

| `space`  | `([ \t\r\n\v\f]+)`                                                 | All whitespace characters, including line breaks.                   |

| `graph`  | `([\x21-\x7E]+)`                                                   | Visible characters (anything except spaces and control characters). |

| `blank`  | `([ \t]+)`                                                         | Space and tab.                                                      |

| `ascii`  | `([\x00-\x7F]+)`                                                   | ASCII characters.                                                   |

| `cntrl`  | `([\x00-\x1F\x7F]+)`                                               | Control characters.                                                 |

## Tests

```bash

$ npm test

```