dirp

dirp

dirp - object directory accessor using tokenized path string.

Installation

$ npm install dirp --save

Examples

var capitals = require('dirp').create();
capitals.set('us.alabama', 'montgomery');
capitals.set('us.california', 'sacramento');
capitals.set('jp.tokyo', 'shinjuku');
capitals.set('jp.osaka', 'osaka');
 
console.log(capitals.get('us.alabama'));
// montgomery
 
console.log(capitals.get('us.california'));
// sacramento
 
console.log(capitals.raw());
// { us: { alabama: 'montgomery', california: 'sacramento' },
//   jp: { tokyo: 'shinjuku', osaka: 'osaka' } }

console.log(capitals.get('us.tokyo')); // incorrect
// undefined
 
capitals.unset('us'); // clear all data at paths that start with 'us' 
console.log(capitals.raw());
// { jp: { tokyo: 'shinjuku', osaka: 'osaka' } }

API

Module Methods

create (creates a new instance of "Dirp"(an internal class))

create(delimiter], data) => instance {Dirp}
create(delimiter) => instance {Dirp}
create(data) => instance {Dirp}
    delimiter {string} Path delimiter. Defaults to '.'
    data {object} Initial object. Defaults to {}

• e.g. "products.users.name", "app/lib/test", "country:state:city" ...
• data is not deep-copied. Use deepCopy method if necessary.

deepCopy (deep-copies an object (provided for convenience)

deepCopy(srcObj) => {object}
    srcObj {object} An object to be copied.

• It only deep-copies stringifiable data with the current implementation.

Instance Methods

set (sets the path to a value)

set(path, value) => {void}
    path {string} Path to a value
    value {any} Arbitrary value

get (gets a value at the path)

get(path) => {any}
    path {string} Path to a value

• undefined is returned if the path is not a leaf.

unset (unsets value at the path)

unset(path) => {void}
    path {string} Path to be unset

exists (tests if the path exists)

exists(path) => {boolean}
    path {string} Path to be tested

raw (returns a raw data {object})

raw() => {object}

clone (returns a new instance of Dirp with a deep-copy of its raw data)

clone() => {Dirp}

• It only deep-copies stringifiable data with the current implementation.