Route helpers generator
Create methods to easily generate paths and url
Dependencies
- path-to-regexp - ^2.1.0
- qs - ^6.5.1
- cli-table - ^0.3.1
- randexp - ^0.5.3
- url
Install
npm install --save route-helpers-generator
or
yarn add route-helpers-generator
Note: it is assumed that this will be used in a modern environment, for legacy environments add babel-polyfill in your app.
Usage
Declare some routes:
const userMatch = ; // => {id: 1} // => null const userPath = ; // => '/users/1' // => '/users/1.json' // => '/users/1#test' // => '/users/1?name=john' // => '/users/1?user%5Bname%5D=john' // => '/users/1?user%5B%5D=1&user%5B%5D=2' const userUrl = ; // => 'http://test.com/users/1' const routesHelper = user: '/users/:id' users: '/users' host: 'http://test.com'routesHelper // => '/users/1'routesHelper // => 'http://test.com/users/1'routesHelper // => '/users/:id'routesHelper // => 'users/:id'routesHelper // => 'users/:id'routesHelperroutesHelper // => 'https://test.com/users/1'routesHelper // => {name: 'user', params: {id: '1'}}routesHelper // => {name: 'users', params: {}}routesHelper // => null
Help Script
Add to package.json to show generated methods
You will need to add babel and babel-cli and use babel-node in case you use presets.
./routesHelper
const routesHelper = user: '/users/:id' users: '/users' host: 'http://test.com' ;
Release
npm publish