trouter - npm Package Compare versions

Comparing version 0.1.1 to 1.0.0

lib/index.js

@@ -0,5 +1,4 @@
+const { METHODS } = require('http');
 const { exec, match, parse } = require('matchit');
 
-const METHODS = ['GET', 'POST', 'PUT', 'DELETE'];
-
 class Trouter {
@@ -6,0 +5,0 @@ constructor(opts) {

package.json

 {
   "name": "trouter",
-  "version": "0.1.1",
-  "description": "WIP",
-  "repository": "lukeed/mri",
+  "version": "1.0.0",
+  "description": "🐟 A fast, small-but-mighty, familiar ~fish~ router",
+  "repository": "lukeed/trouter",
   "main": "lib/index.js",
@@ -23,3 +23,7 @@ "license": "MIT",
   },
-  "keywords": [],
+  "keywords": [
+    "route",
+    "router",
+    "routing"
+  ],
   "dependencies": {
@@ -26,0 +30,0 @@ "matchit": "^1.0.0"

readme.md

 # trouter [![Build Status](https://travis-ci.org/lukeed/trouter.svg?branch=master)](https://travis-ci.org/lukeed/trouter)
 
-> WIP
+> 🐟 A fast, small-but-mighty, familiar ~fish~ router
 
@@ -9,3 +9,3 @@
 ```
-npm install --save trouter
+$ npm install --save trouter
 ```
@@ -17,3 +17,29 @@
 ```js
-const trouter = require('trouter');
+const Trouter = require('trouter');
+const router = new Trouter();
+
+// Define all routes
+router
+  .get('/users', _ => {
+    console.log('> Getting all users');
+  })
+  .add('POST', '/users', _ => {
+    console.log('~> Adding a user');
+  })
+  .get('/users/:id', val => {
+    console.log('~> Getting user with ID:', val);
+  });
+
+// Find a route definition
+let obj = router.find('GET', '/users/123');
+//=> obj.params ~> { id:123 }
+//=> obj.handler ~> Function
+
+// Execute the handler, pass value
+obj.handler( obj.params.id );
+//=> ~> Getting user with ID: 123
+
+// Returns `false` if no match
+router.find('DELETE', '/foo');
+//=> false
 ```
@@ -23,10 +49,90 @@
 
-### trouter()
+### Trouter()
 
+Initializes a new `Trouter` instance. Currently accepts no options.
 
+### trouter.add(method, pattern, handler)
+Returns: `self`
 
+Stores a `method` + `pattern` pairing internally, along with its handler.
+
+#### method
+Type: `String`
+
+Any valid HTTP method name.
+
+#### pattern
+Type: `String`
+
+Unlike most router libraries, Trouter does not use `RegExp` to determine pathname matches. Instead, it uses string comparison which is much faster, but also limits the pattern complexity.
+
+The supported pattern types are:
+
+* static (`/users`)
+* named parameters (`/users/:id`)
+* nested parameters (`/users/:id/books/:title`)
+* optional parameters (`/users/:id?/books/:title?`)
+* any match / wildcards (`/users/*`)
+
+#### handler
+Type: `Function`
+
+The function that should be tied to this `pattern`.
+
+> **Important:** Trouter does not care what your function signature looks like!<br> You are not bound to the `(req, res)` standard.
+
+### trouter.find(method, url)
+Returns: `Object|Boolean`<br>
+Searches within current instance for a `method` + `pattern` pairing that matches the current `method` + `url`.
+
+This method will return `false` if no match is found. Otherwise it returns an Object with `params` and `handler` keys.
+
+#### method
+Type: `String`
+
+Any valid HTTP method name.
+
+#### url
+Type: `String`
+
+The URL used to match against pattern definitions. This is typically `req.url`.
+
+### trouter.METHOD(pattern, handler)
+
+This is an alias for [`trouter.add(METHOD, pattern, handler)`](#trouteraddmethod-pattern-handler), where `METHOD` is **any** lowercased HTTP method name.
+
+```js
+const noop = _ => {}:
+const app = new Trouter();
+
+app.get('/users/:id', noop);
+app.post('/users', noop);
+app.patch('/users/:id', noop);
+
+// less common methods too
+app.trace('/foo', noop);
+app.purge('/bar', noop);
+app.copy('/baz', noop);
+```
+
+
 ## Benchmarks
 
+> Run on Node v6.11.1
+
 ```
-#
+GET / ON /
+  --> 6,621,618 ops/sec ±1.43% (91 runs sampled)
+
+POST /users ON /users
+  --> 2,180,156 ops/sec ±1.06% (91 runs sampled)
+
+GET /users/123 ON /users/:id
+  --> 1,126,468 ops/sec ±0.44% (93 runs sampled)
+
+PUT /users/123/books ON /users/:id/books/:title?
+  --> 1,003,157 ops/sec ±0.43% (94 runs sampled)
+
+DELETE /users/123/books/foo ON /users/:id/books/:title
+  --> 827,550 ops/sec ±0.53% (91 runs sampled)
 ```
@@ -33,0 +139,0 @@

New alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5784

increased by106.65%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

140

increased by311.76%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes