🐟 A fast, small-but-mighty, familiar ~fish~ router. 

🐟 A fast, small-but-mighty, familiar ~fish~ router

lukeed

trouter

Error

Ignore

Warn

License

Maintenance

Miscellaneous

Quality

Supply chain risk

Vulnerability

Admins only

Organization members

Dashboard

<upgradeLink>Upgrade</upgradeLink> to access this feature

About

Blog

Socket CLI

Customers

Socket Dependency Search

Docs

Socket for GitHub

Love

Impersonation Mode Active

Update your browser to the latest version for the best experience.

Your web browser is outdated

Use another browser for the best experience.

Your web browser is unsupported

{{count, number}} commits last two months

{{count, number}} critical severity alert

{{count, number}} critical severity alerts

{{count, number}} dependency vulnerability

{{count, number}} dependency vulnerabilities

{{count, number}} development dependencies

{{count, number}} transitive dependencies

{{count, number}} version published last month

{{count, number}} versions published last month

{{count, number}} version published in last two months

{{count, number}} versions published in last two months

{{count, number}} version published last week

{{count, number}} versions published last week

{{count, number}} version published last year

{{count, number}} versions published last year

Socket undergoes annual SOC2 Type II audits. Socket customers can request a copy of the full SOC2 Type II report.

Allows organization owners and admins to access detailed records of actions taken by members of their organization, complete with timestamps.

Prevent compromised packages from infiltrating your supply chain by monitoring for changes in real-time.

Join our Discord community to get help from Socket engineers and other Socket users.

Compare millions of open source packages on socket.dev

Detect malicious code and risky behavior (e.g. network) in your dependencies using "deep package inspection"

All data is encrypted in transit and at rest using industry standard encryption algorithms.

Get a dedicated Socket account manager and access to Socket’s Customer Success team.

Get dedicated support from Socket engineers via email and Slack.

"Shift left" with the Socket Chrome extension and give intervene early, before developers choose risky or low quality dependencies.

Catch developers using risky dependencies and give them a "speed bump" to encourage good behavior

Install the Socket GitHub app to receive real-time dependency scanning and reports with every pull request.

Integrate Socket into your GitHub SCM to prevent risky dependencies from being installed.

Socket scans for vulnerabilities in your dependencies, including CVEs, security advisories, and more.

Socket supports dependencies in many languages, with most popular ecosystems coming in 2024. We've got you covered no matter what languages you use.

Enforce license policies across your organization

Receive a Microsoft Teams message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Get help migrating from Socket's free plan to Socket's paid plans.

Run Socket on-premises or in your own cloud environment.

Query for any dependency (at any version) across your entire organization

Integrate Socket into your CI/CD pipeline to prevent risky dependencies from being deployed to production.

Analyze an entire project to find supply chain risks

Tag projects to organize and filter your projects

Restrict access based on the roles of individual users within an organization.

Receive a Slack message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket is SOC2 Type II compliant and undergoes annual audits.

The Socket CLI allows teams to prevent risky dependencies from being installed, and to get dependency insights from the command line.

Socket supports SAML SSO for single sign-on and identity management.

Integrate Socket into your VS Code IDE to prevent risky dependencies from being installed.

Get a POST request anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket will analyzed your SBOMs up to a maximum number of dependencies.

API that allows you to analyze a project, lookup package scores and alerts, and more.

Create API tokens to authenticate with the Socket API and CLI.

The number of developers in your team. A developer is someone who made a commit to your organization's repositories scanned by Socket in the past month.

Use Socket to protect your private repositories.

Socket is always free for open source projects.

Socket retains all reporting data for 3 months, 1 year, or a custom term of your choice.

Access the threat feed that powers Socket.

Unlimited scale, self-hosting, and priority support for large teams.

For open-source projects, individuals, and small teams.

For growing teams with enhanced scale, security, and support.

There is a package with a similar name that is downloaded much more often.

There are packages with similar names that are downloaded much more often.

This may not be the package you want!

Instance

Alert Locations

Package

The {{ecosystem}} package {{- packageName}} receives a total of {{numWeeklyDownloadCount, number}} weekly downloads. As such, {{- packageName}} popularity was classified as {{popularity}}.

Is {{- packageName}} popular?

Is {{- packageName}} safe to use?

Is {{- packageName}} well maintained?

What is {{- packageName}}?

{{packageDescription}}Version: {{versionString}} was published by {{publisherName}}. Start using Socket to analyze {{- packageName}} and its {{dependencyCount, number}} dependencies to secure your app from supply chain attacks.

Sorry, it seems this package was removed from the registry

Package was removed

This package version has been unpublished, mostly likely due to security reasons

Package version was removed

Provide a detailed description of the malware...

Socket fights vulnerabilities and provides visibility, defense-in-depth, and proactive supply chain protection for JavaScript, Python, and Go dependencies.

Socket - Secure your dependencies. Ship with confidence.

Compare versions

{{- packageName}} - npm Package Compare versions

export default class Trouter<T = Function> {

	add(method: Methods, pattern: Pattern, ...handlers: T[]): this;

	use(pattern: Pattern, ...handlers: T[]): this;

	all(pattern: Pattern, ...handlers: T[]): this;

	get(pattern: Pattern, ...handlers: T[]): this;

	head(pattern: Pattern, ...handlers: T[]): this;

	patch(pattern: Pattern, ...handlers: T[]): this;

	options(pattern: Pattern, ...handlers: T[]): this;

	connect(pattern: Pattern, ...handlers: T[]): this;

	delete(pattern: Pattern, ...handlers: T[]): this;

	trace(pattern: Pattern, ...handlers: T[]): this;

	post(pattern: Pattern, ...handlers: T[]): this;

	put(pattern: Pattern, ...handlers: T[]): this;

		this.head = this.add.bind(this, 'HEAD');

		this.patch = this.add.bind(this, 'PATCH');

		this.options = this.add.bind(this, 'OPTIONS');

		this.connect = this.add.bind(this, 'CONNECT');

		this.delete = this.add.bind(this, 'DELETE');

		this.trace = this.add.bind(this, 'TRACE');

		this.post = this.add.bind(this, 'POST');

		let handlers = [].concat.apply([], fns);

		let { keys, pattern } = parse(route, true);

		this.routes.push({ keys, pattern, method: '', handlers, midx: MAP[''] });

		this.routes.push({ keys, pattern, method, handlers, midx: MAP[method] });

		let matches=[], params={}, handlers=[];

			if (tmp.midx === midx  || tmp.midx === 0 || (isHEAD && tmp.midx===1) ) {

					if (matches.groups !== void 0) for (k in matches.groups) params[k]=matches.groups[k];

					tmp.handlers.length > 1 ? (handlers=handlers.concat(tmp.handlers)) : handlers.push(tmp.handlers[0]);

for (j=0; j < tmp.keys.length;) params[tmp.keys[j]]=matches[++j];

  "description": "🐟 A fast, small-but-mighty, familiar ~fish~ router",

    "test": "tape -r esm test/*.js | tap-spec"

# trouter [![Build Status](https://badgen.now.sh/travis/lukeed/trouter)](https://travis-ci.org/lukeed/trouter)

# trouter [![CI](https://github.com/lukeed/trouter/actions/workflows/ci.yml/badge.svg)](https://github.com/lukeed/trouter/actions/workflows/ci.yml)

> 🐟 A fast, small-but-mighty, familiar ~fish~ router

    console.log('~> Getting user with ID:', val);

let obj = router.find('GET', '/users/123');

### trouter.add(method, pattern, ...handlers)

Stores a `method` + `pattern` pairing internally, along with its handler(s).

Any uppercased, [valid HTTP/1.1 verb](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods#Specifications) &mdash; choose from one of the following:

GET  HEAD  PATCH  OPTIONS  CONNECT  DELETE  TRACE  POST  PUT

Trouter supports simple route patterns which are fast and well readable but limited. If you need more complex patterns, you can pass an instance of `RegExp` with parameters specified as named capture groups.

> **Important:** RegExp named capture groups are [supported in Node.js 10.x](https://node.green/#ES2018-features--RegExp-named-capture-groups) and above!

* nested parameters (`/users/:id/books/:title`)

* optional parameters (`/users/:id?/books/:title?`)

* suffixed parameters (`/movies/:title.mp4`, `movies/:title.(mp4|mov)`)

The function(s) that should be tied to this `pattern`.

Because this is a [rest parameter](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/rest_parameters), whatever you pass will _always_ be cast to an Array.

> **Important:** Trouter does not care what your function signature looks like! You are not bound to the `(req, res)` standard, or even passing a `Function` at all!

This is an alias for [`trouter.add('', pattern, ...handlers)`](#trouteraddmethod-pattern-handlers), matching **all** HTTP methods.

However, unlike [`trouter.all`](#trouterallpattern-handlers), the `pattern` you defined **IS NOT RESTRICTIVE**, which means that the route will match any & all URLs that start (but not end) with a matching segment.

router.use('/foo/:name', 'USE /foo/:name');

router.post('/foo/:name', 'POST /foo/:name');

router.head('/foo/:name/hello', 'HEAD /foo/:name/hello');

router.find('POST', '/foo/bar').handlers;

//=> ['USE /foo', 'USE /foo/:name', 'POST /foo/:name']

router.find('HEAD', '/foo/bar/hello').handlers;

//=> ['USE /foo', 'USE /foo/:name', 'HEAD /foo/:name/hello']

_Compare this snippet with the one below to see differences between `trouter.all` and this method._

However, unlike [`trouter.use`](#trouterusepattern-handlers), the `pattern` you defined **IS RESTRICTIVE** and behaves like any other [`trouter.METHOD`](#trouteraddmethod-pattern-handlers) route. This means that the URL must match the defined `pattern` exactly – or have the appropriate optional and/or wildcard segments to accommodate the desired flexibility.

router.all('/foo/:name', 'ALL /foo/:name');

//=> ['ALL /foo/:name', 'POST /foo/:name']

_Compare this snippet with the one above to see differences between `trouter.use` and this method._

This is an alias for [`trouter.add(METHOD, pattern, ...handlers)`](#trouteraddmethod-pattern-handlers), where `METHOD` is any lowercased HTTP verb.

Searches within current instance for **all** `method` + `pattern` pairs that satisfy the current `method` + `url`.

> **Important:** Parameters and handlers are assembled/gathered _in the order that they were defined!_

This method will always return an Object with `params` and `handlers` keys.

* `params` &mdash; Object whose keys are the named parameters of your route pattern.

* `handlers` &mdash; Array containing the `...handlers` provided to [`.add()`](#trouteraddmethod-pattern-handlers) or [`.METHOD()`](#troutermethodpattern-handlers)

> **Note:** The `handlers` and `params` keys will be empty if no matches were found.

> **Note:** When searching for `HEAD` routes, `GET` routes will also be inspected.

		@@ -9,3 +9,3 @@ // Thank you: @fwilkerson, @stahlstift

		export default class Trouter<T = Function> {
		export class Trouter<T = Function> {
		find(method: Methods, url: string): {
		@@ -12,0 +12,0 @@ params: Record<string, string>;

		@@ -1,2 +0,2 @@
		const parse = require('regexparam');
		const { parse } = require('regexparam');

		@@ -16,3 +16,3 @@ const MAP = {

		module.exports = class Trouter {
		class Trouter {
		constructor() {
		@@ -74,1 +74,3 @@ this.routes = [];
		}

		exports.Trouter = Trouter;

		{
		"name": "trouter",
		"version": "3.2.1",
		"version": "4.0.0",
		"repository": "lukeed/trouter",
		@@ -10,2 +10,10 @@ "description": "🐟 A fast, small-but-mighty, familiar ~fish~ router",
		"license": "MIT",
		"exports": {
		".": {
		"types": "./index.d.ts",
		"import": "./index.mjs",
		"require": "./index.js"
		},
		"./package.json": "./package.json"
		},
		"files": [
		@@ -27,3 +35,3 @@ "index.js",
		"prepack": "bundt index.mjs",
		"test": "tape -r esm test/*.js \| tap-spec"
		"test": "uvu -r esm test"
		},
		@@ -36,10 +44,9 @@ "keywords": [
		"dependencies": {
		"regexparam": "^1.3.0"
		"regexparam": "^3.0.0"
		},
		"devDependencies": {
		"bundt": "1.1.2",
		"esm": "3.2.22",
		"tap-spec": "5.0.0",
		"tape": "4.11.0"
		"esm": "3.2.25",
		"uvu": "0.5.1"
		}
		}

		@@ -1,2 +0,2 @@
		# trouter [![Build Status](https://badgen.now.sh/travis/lukeed/trouter)](https://travis-ci.org/lukeed/trouter)
		# trouter [![CI](https://github.com/lukeed/trouter/actions/workflows/ci.yml/badge.svg)](https://github.com/lukeed/trouter/actions/workflows/ci.yml)

		@@ -16,3 +16,3 @@ > 🐟 A fast, small-but-mighty, familiar ~fish~ router
		```js
		import Trouter from 'trouter';
		import { Trouter } from 'trouter';

		@@ -84,2 +84,3 @@ const router = new Trouter();
		* any match / wildcards (`/users/*`)
		* optional wildcards (`/users/*?`)

		@@ -86,0 +87,0 @@ #### ...handlers

Improved metrics

Dependency changes