raml-path-match

RAML Path Match

Path matching utility based on the RAML spec.

Installation

npm install raml-path-match --save

Usage

You must require the module and call it as a function with options to get the path matching utility back.

const ramlPathMatch = require('raml-path-match')
const utils = require('./utils')

// Initialization Options
const options = {}

// Array<webapi-parser.Parameter>
const parameters = utils.getPathParameters()

// Create a simple path matching instance.
const pathMatch = ramlPathMatch('/{route}', parameters, options)

pathMatch('/test'); //=> { match: '/test', params: { route: 'test' } }

Initialization Options

• end - When set to false, the route will only match the beginning of paths.
• strict - When set to true, the route must match exactly without trailing slash.
• sensitive - When set to true, the route will be case-sensitive.

Routes

The route is a string that can be interpolated with parameters. E.g. /{route}.

Parameters

Parameters in the route string must be defined as an array of webapi-parser Parameter objects.

Optional parameters

Parameters can be optional according to the RAML spec. With optional parameters, /{route} will match just /. When the parameter is optional and not matched, the parameter value will be set to undefined.

Matching the path

The path matching instance will return a function after you give it the route template. This function is used to match the current path against the route template. If the route does not match, false is returned. If it does match, an object will be returned.

{
  match: '/123',
  params: {
    route: 123
  }
}

The above is an example of passing the path /123 to the result of the previous example. Notice that parameters will be automatically sanitized to the native JavaScript types.

Updates

You can merge more parameters into the path after creation using pathMatch.update(params). It'll return a new patch matching function.

License

Apache 2.0