extract-params

Extract Params

Installation

npm install extract-params --save

Then, in your app:

var extractParams = require('extract-params');

API

extractParams(str, pattern)

This function extracts pattern parameters by matching str at the start (see examples below).

pattern parameters must be in the following format: :camelCase

If str doesn't match pattern at the start, returns {}.

Example 1:

var params = extractParams(
  '/users/123/friends/456/photo',
  '/users/:userId/friends/:friendId/photo'
);

/* 
  Returns:
    {
      userId: '123',
      friendId: '456'
    }
*/

Example 2:

var params = extractParams(
  '/home/users/123/friends/456/photo',
  '/users/:userId/friends/:friendId/photo'
);

/* 
  Returns:
    {}
      
  because `str` matches `pattern`, but not at the start.
*/

Running Tests

npm test

License

MIT