Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including pathname-js with all npm packages installed. Try it out:

var pathnameJs = require("pathname-js")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

pathname-js v1.0.12

Simply manage paths.

Pathname JS 🛣

npm version Maintainability

Simply manage paths.

Install

npm install pathname-js

Usage

var Pathname = require('pathname-js');

var pathname = new Pathname("some/path/with/an/:id");
pathname.string;
// => "some/path/with/an/:id"

pathname[2] = 'to';
pathname[3] = 'number';
pathname.id = 4;
pathname.string;
// => "some/path/to/number/4"

pathname.concat('and', 'letter/:letter');
pathname.letter = 'A';
pathname.string;
// => "some/path/to/number/4/and/letter/A"

Pathname ⇐ Array

Kind: global class
Extends: Array

new Pathname(...parts)

Create a Pathname object.

ParamTypeDescription
...partsstring | ArraySame value as concat's parameters.

pathname.root : boolan

true if the pathname is absolute, false in the other case.

Kind: instance property of Pathname

pathname.keys : Array.<string>

The path parameter keys.

Kind: instance property of Pathname
Read only: true

pathname.clone : Pathname

A clone of the path.

Kind: instance property of Pathname
Read only: true

pathname.raw : string

Path string value, without replacing parameters by values.

Kind: instance property of Pathname
Read only: true

pathname.string : string

Path string value, with parameters replaced by values. When set, it can have new parameters.

Kind: instance property of Pathname

pathname.toString() ⇒ string

Kind: instance method of Pathname
Returns: string - Value of Patname#string

pathname.match(pattern) ⇒ Array

Match a pattern on the path.

Kind: instance method of Pathname
Returns: Array - The match result.

ParamTypeDescription
patternRegExpThe pattern to match.

pathname.replace(pattern) ⇒ Pathname

Replace a pattern on the path.

Kind: instance method of Pathname
Returns: Pathname - The replaced path.

ParamTypeDescription
patternRegExpThe pattern to replace.

pathname.push(...parts) ⇒ Pathname

Same as Patname#concat

Kind: instance method of Pathname
Returns: Pathname - Itself.

ParamTypeDescription
...partsPathname | Array | stringThe parts to add to the path.

pathname.concat(...parts) ⇒ Pathname

Adds parts to the path.

Kind: instance method of Pathname
Returns: Pathname - Itself.

ParamTypeDescription
...partsPathname | Array | stringThe parts to add to the path.

pathname.clear() ⇒ Pathname

Empty the path.

Kind: instance method of Pathname
Returns: Pathname - Itself.

pathname.reset() ⇒ Pathname

Set all the path parameters to null.

Kind: instance method of Pathname
Returns: Pathname - Itself.

Metadata

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free