npmpackage.info

Gathering detailed insights and metrics for @tehshrike/regexparam

An interesting fact about npm is that it started as a weekend project by its creator, Isaac Z. Schlueter, in 2009. It was officially launched in January 2010.

@tehshrike/regexparam

A tiny (332B) utility that converts route patterns into RegExp. Limited alternative to `path-to-regexp` 🙇‍♂️

1.0.2

MIT

JavaScript

679

2.1

Installations

npm install @tehshrike/regexparam

Score

67.3

Supply Chain

95.1

Quality

74.8

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Contributors

View all 1 contributors

Developer

TehShrike

Module System

BETA

CommonJS

Statistics

32 Commits

3 Watching

1 Branches

1 Contributors

Updated on 05 Feb 2019

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

679

Last day

Compared to previous day

Last week

100%

Compared to previous week

Last month

-33.3%

Compared to previous month

Last year

-38.4%

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

gzip-size jsmd mk-dirs pretty-bytes tap-color tape terser

Versions

@tehshrike/regexparam

regexparam with longer variable names and support for custom regex patterns.

A tiny (332B) utility that converts route patterns into RegExp. Limited alternative to path-to-regexp 🙇

With @tehshrike/regexparam, you may turn a pathing string (eg, /users/:id) into a regular expression.

An object with shape of { keys, pattern } is returned, where pattern is the RegExp and keys is an array of your parameter name(s) in the order that they appeared.

Unlike path-to-regexp, this module does not create a keys dictionary, nor mutate an existing variable. Also, this only ships a parser, which only accept strings. Similarly, and most importantly, @tehshrike/regexparam only handles basic pathing operators:

Static (/foo, /foo/bar)
Parameter (/:title, /books/:title, /books/:genre/:title)
Optional Parameters (/:title?, /books/:title?, /books/:genre/:title?)
Wildcards (*, /books/*, /books/:genre/*)
Regex Parameters (/user/:userId(\\d+))

Lastly, please note that while this route-parser is not slow, you should use matchit or trouter if performance is of critical importance. This is especially true for backend/server scenarios!

This module exposes two module definitions:

ES Module: dist/regexparam.mjs
CommonJS: dist/regexparam.js

Install

$ npm install --save @tehshrike/regexparam

Usage

const regexparam = require('@tehshrike/regexparam');

1
2let foo = regexparam('users/*')
3foo.keys // => ['wild']
4foo.pattern // => /^\/users\/(.*)(?:\/)?\/?$/i
5
6let bar = regexparam('/books/:genre/:title?')
7bar.keys // => ['genre', 'title']
8bar.pattern // => /^\/books\/([^\/]+?)(?:\/([^\/]+?))?(?:\/)?\/?$/i
9
10bar.pattern.test('/books/horror') //=> true
11bar.pattern.test('/books/horror/goosebumps') //=> true
12
13// Example param-assignment
14function exec(path, { keys, pattern }) {
15	const matches = pattern.exec(path)
16	const out = {}
17	keys.forEach((key, i) => {
18		out[key] = matches[i + 1] || null
19	})
20
21	return out
22}
23
24exec('/books/horror', bar) //=> { genre:'horror', title:null }
25
26exec('/books/horror/goosebumps', bar) //=> { genre:'horror', title:'goosebumps' }

Important: When matching/testing against a generated RegExp, your path must begin with a leading slash ("/")!

API

regexparam(str)

Returns: Object

str

Type: String

The route/pathing string to convert.

Note: It does not matter if your str begins with a / — it will be added if missing.

License

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

3

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

SAST

Determines if the project uses static code analysis.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

Score

2.1

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More