Giter Club home page Giter Club logo

object-traversed's Introduction

#Object Traversed

Build Status view on npm Software License npm npm

A very simple, lightweight utility on traversing object graphs using a string.

How to use

npm install --save object-traversed
yarn add  object-traversed

If using via normal javascript include, then it is exported as window.objectTraverse.

API

var traversed = require('object-traversed');

var graph = {  
   field : {
      deep : {
         x : 1,
         y: 2
      }
   },
   field2: [],
   deepFunc : { someFunc: function(arg) {} }
   
};
//get a value
traversed(graph).get('field.deep');
//get with a default
traversed(graph).get('field.deep','default return val if not found'); 

//check if something is defined
traversed(graph).has('field.deep.missing');

//sets a value
traversed(graph).set('field.deep.z',5);
   
//helpers
traversed(graph).isArray('field2');
traversed(graph).isString('field2');
traversed(graph).isObject('field2');
traversed(graph).isNumber('field2');
          
//exec
traversed(graph).exec('deepFunc.someFunc','arg');         

//delete
traversed(graph).delete('field.deep.x');

//push - add vall to the array, will create if it doesn't exists
traversed(graph).push('a.b.c',val);

//create create the given path if it doesn't exists, will skip none object types
traversed(graph).create('a.b.c');
traversed(graph).get('a.b.c'); //{ a : { b : { c: {} } }

๐Ÿ”‘ License

MIT ยฉ ChantouchSek

object-traversed's People

Contributors

chantouch avatar chantouchsek avatar dependabot[bot] avatar touchsek avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

418sec

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.