Pathname JS 🛣

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

• Pathname ⇐ Array
  • new Pathname(...parts)
  • .root : boolan
  • .keys : Array.<string>
  • .clone : Pathname
  • .raw : string
  • .string : string
  • .toString() ⇒ string
  • .match(pattern) ⇒ Array
  • .replace(pattern) ⇒ Pathname
  • .push(...parts) ⇒ Pathname
  • .concat(...parts) ⇒ Pathname
  • .clear() ⇒ Pathname
  • .reset() ⇒ Pathname

new Pathname(...parts)

Create a Pathname object.

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.

pathname.replace(pattern) ⇒ Pathname

Replace a pattern on the path.

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

pathname.push(...parts) ⇒ Pathname

Same as Patname#concat

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

pathname.concat(...parts) ⇒ Pathname

Adds parts to the path.

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

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.