Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    dobjpublic

    dobj

    Object deep dot access. set, get, del methods available


    License

    MIT License see LICENSE file.

    Installation

    npm install dobj

    API documentation

    get(path:string) : *

    var obj = {
        a: {
            b: {
                c: 'test'
            }
        }
    };
     
    dobj(obj).get('a.b.c');
    // => 'test'

    set(path:string, value:*) : dobj

    var obj = {
        a: {
            b: {
                c: 'test'
            }
        }
    };
     
    dobj(obj)
        .set('a.b.c', 'ok')
        .get('a.b.c');
    // => 'ok'

    forceSet(path:string, value:*) : dobj

    This method sets the property (by path) even if the path does not exists. For example:

    var obj = {};
     
    dobj(obj)
        .forceSet('a.b.c', 'ok')
        .get('a.b.c');
    // => 'ok'

    del(path:string) : dobj

    var obj = {
        a: {
            b: {
                c: 'test'
            }
        }
    };
     
    dobj(obj)
        .del('a.b.c')
        .get('a.b.c');
    // => undefined

    silentGet(path:string) : * and silentDel(path:string) : dobj

    These methods are a "silent" versions of get and del. If you call them on paths that does not exists no exception will be thrown. If path is incorrect silentGet will return undefined and silentDel will remain silent and return dobj as normal del.

    install

    npm i dobj

    Downloadsweekly downloads

    21

    version

    1.5.0

    license

    MIT

    homepage

    github.com

    last publish

    collaborators

    • avatar