Path Template

Match and build paths from rails/sinatra-style url path templates.

Installation

npm install path-template

Usage

var PathTemplate = require("path-template");

PathTemplate.parse(string)

Returns a new path template, generated from the given string.

var template = PathTemplate.parse("/users/:userID");

PathTemplate.inspect(template)

Returns the string representation of the given path template.

PathTemplate.inspect(template);   // => "/users/:userID"

PathTemplate.variables(template)

Returns an array of the variable names used in the given path template as strings.

var template = PathTemplate.parse("/*tree/photos/:name(.:format)");
PathTemplate.variables(template);   // => ["tree", "name", "format"]

PathTemplate.format(template, obj)

Returns a path as a string built by combining the template and the parameters in obj

PathTemplate.format(template, {userID: 1});   // => "/users/1"

PathTemplate.match(template, string)

If string is a path matching the format of template, returns a match object containing the parameters found in the path, otherwise returns undefined.

PathTemplate.match(template, "/users/1");    // => {userID: "1"}
PathTemplate.match(template, "/photos/1");   // => undefined

An array of templates can be given as the first argument, in which case a match object will be returned if any of the templates match. The match object will have a template property referencing the template with which the path matched.

var user = PathTemplate.parse("/users/:userID"),
    photo = PathTemplate.parse("/photos/:photoID"),
    templates = [user, photo];

var match = PathTemplate.match(templates, "/users/1");
match;                                  // => {userID: "1"}
PathTemplate.inspect(match.template);   // => "/users/:userID"
user === match.template;                // => true

PathTemplate.add(template, string)

Returns a new path template by appending the path described by string.

var userPhoto = PathTemplate.add(template, "/photos/:photoID");
PathTemplate.inspect(userPhoto);   // => "/users/:userID/photos/:photoID"

PathTemplate.without(template, string)

Returns a new path without the path segments described by string.

var template = PathTemplate.parse("/groups/:groupID/users/:userID/photos"),
    groupPhotos = PathTemplate.without(template, "/users/:userID");

PathTemplate.inspect(groupPhotos);   // => "/groups/:groupID/photos"

Template syntax

The characters :, *, (, and ) have special meanings.

: indicates the following segment is the name of a variable * indicates the following segment is the splat/glob ( starts an optional segment ) ends an optional segment

additionally / and . will start a new segment.

Static Segments

"/foo/bar.baz"
 ^   ^   ^
 |   |   Starts a segment, matching ".baz"
 |   |
 |   Starts a segment, matching "/bar"
 |
 Starts a segment, matching "/foo"

Variables

"/foo/:bar.baz"
 ^    ^   ^
 |    |   Starts a new segment, that matches ".baz"
 |    |
 |    Matches anything up to the start of the next segment, with the value
 |    being stored in the "bar" parameter of the returned match object
 |
 Starts a segment, matching "/foo"

Splat/Glob

"/foo/*bar"
 ^    ^
 |    Matches any number of segments, the values being stored as an array
 |    in the "bar" parameter of the returned match object
 |
 Starts a segment, matching "/foo"

Anonymous Splat/Glob

"/foo/*"
 ^    ^
 |    Matches any number of segments, the values will not appear in the
 |    returned match object
 |
 Starts a segment, matching "/foo"

Optional Segments

"/foo(/baz)/baz"
 ^   ^    ^^
 |   |    |Starts a new segment, that matches "/baz"
 |   |    |
 |   |    Ends the optional segment
 |   |
 |   Starts an optional segment, this segment need not be in the path being
 |   matched for the match to be successful
 |
 Starts a segment, matching "/foo"

Licence

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

drselump14 / path-template Goto Github PK

path-template's Introduction