vardars / dotize Goto Github PK

Convert complex js object to dot notation js object

License: MIT License

JavaScript 88.15% HTML 11.85%

dotize's Introduction

dotize

Convert (Complex js object)

{
  "status": "success",
  "auth": {
    "code": 123,
    "name": "qwerty asdfgh"
  }
}

to (Dot notation js object)

{
  "status": "success",
  "auth.code": 123,
  "auth.name": "qwerty asdfgh"
}

npm

npm install dotize

bower

bower install dotize

tests

npm install -g mocha
mocha test/test.js

dotize's People

Contributors

Stargazers

Watchers

Forkers

ilgooz iamrenejr electblake razzinteractive gimalon brainysmurf machinaexphilip jank1310 fork-save anavalo

dotize's Issues

keyword/number documents should probably return the raw value

dotize.convert(null) ==> {  } // expect: null
dotize.convert(true) ==> {  } // expect: true
dotize.convert(1984) ==> {  } // expect: 1984
dotize.convert(null,"foo") ==> {  } // expect: {foo:null}
dotize.convert(true,"foo") ==> {  } // expect: {foo:true}
dotize.convert(1984,"foo") ==> {  } // expect: {foo:1984}

Need types for typescript usage

bug with strings

dotize.convert("foo") ==> {0:"f",1:"o",2:"o"} // expect "foo"
dotize.convert("foo","foo") ==> { foo.0: "f", foo.1: "o", foo.2: "o" } // expect {foo:"foo"}

Number as object key

Is this behavior normal?

dotize.backward({"2": "2"}) => [ null, null, "2" ] // expect { "2" : "2"}

License

Can you mention the license please? Thanks!

wishlist

Reverse method for "convert"
Custom delimiter symbol eg: -,_
Arrays convert config ( exclude prototypes, map array to index-like object)

Can you publish this to NPM?

Do you mind publishing this to NPM to allow easier downloading.

Thanks,

arrays should have a consistant notation

dotize.convert([])   ==> {  } // expect: [] ???
dotize.convert([],"foo") ==> {  } // expect: {foo:[]} ???
OKAY!: dotize.convert(["foo"]) ==> {0:"foo"}
OKAY!: dotize.convert(["foo"],"foo") ==> {foo.0:"foo"}

dotize.convert([[[{foo:"one"}],[{foo:"two"}]],[[{foo:"three"}],[{foo:"four"}]]]) ==>
    { 0.0[0].foo: "one", 0.1[0].foo: "two", 1.0[0].foo: "three", 1.1[0].foo: "four" }
    // expect: { 0.0.0.foo: "one", 0.1.0.foo: "two", 1.0.0.foo: "three", 1.1.0.foo: "four" }

Nice work.
I found a little error in you code.
You are missing a check for if prefix is not defined in line 21 like you do all the other places in the code. This error causes a dot to be added to the beginning of a property name of a primitive type when no prefix is supplied.

The line should look like this:
newobj[(p ? p + "." : "") + f] = o[f]; // primitive

Handling of empty objects

When running dotize, I expect empty objects (such as {}, cases where Object.keys().length === 0) to effectively be removed. Since there is nothing to flatten, no variables below it can be defined. Is it intentional that empty objects remain in the resulting object?

Keys prefixed with dot when used with arrays

When using arrays, the keys become prefixed with a dot ., even when no prefix is set. For example:

dotize.convert({data: [ {obj0key: 'obj0val'}, {obj1key: 'obj1val'} ] })

This returns:

{ '.data[0].obj0key': 'obj0val', '.data[1].obj1key': 'obj1val' }

Expected return:

{ 'data[0].obj0key': 'obj0val', 'data[1].obj1key': 'obj1val' }