0.1.0 • Published 7 years ago

nobject v0.1.0

Weekly downloads
5
License
MIT
Repository
github
Last release
7 years ago

nobject

Nested javascript objects

Install

Install with npm

$ npm i nobject --save

Usage

const Nobject = require('nobject');

const myNobject = new Nobject

// Set values either by array or just by argument
myNobject.set(['a', 'a', 'a'], 1)
myNobject.set('a', 'a', 'b', 2)

// Get values the same way
myNobject.get('a', 'a', 'a')
// >> 1
myNobject.get(['a', 'a', 'b'])
// >> 2
myNobject.get('x', 'y')
// >> undefined

// Crawl a nobject just like an array
myNobject.forEach((keys, value) => {
  console.log(keys, value)
  if (/* done iterating */)
    return false
  else
    return true //or anything other than false
})
// >> ['a', 'a', 'a'] 1
// >> ['a', 'a', 'b'] 2

// Output JSON
myNobject.toJSON()
// >> { "a" : { "a" : { "a" : 1, "b" : 2 } } }

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

License

Copyright © 2016 Licensed under the MIT license.


This file was generated by readme-generator on November 03, 2016.