Wondering what’s next for npm?Check out our public roadmap! »

    path-notation
    TypeScript icon, indicating that this package has built-in type declarations

    2.1.0 • Public • Published

    PathNotation

    A dot-notation based path string which yields key literals, allows for the inclusion of the "." character in keys and square bracket notation in path strings, promotes readability of path strings and provides other useful utilities for reasoning and working with objects paths.

    Example:

    import PathNotation from 'path-notation';
    
    const path = new PathNotation('foo', 'bar', 2, '10','baz\\.qux');
    
    console.log(`Path notation string: ${path}`); 
    // Path notation string: foo.bar[2].10[baz.qux]
    
    console.log(`Number of keys in the path: ${path.length}`);
    // Number of keys in the path: 5
    
    console.log(`First key in the path: ${path.firstKey}`);
    // First key in the path: foo
    
    console.log(`Last key in the path: ${path.lastKey}`);
    // Last key in the path: baz.qux
    
    // Create a PathNotation instance from a path notation string.
    const pathStr = new PathNotation('foo.bar[2].10[baz.qux]');
    
    console.log('\nKeys')
    for(const key of pathStr) {
      console.log(`  Key: ${key}; Type ${typeof key}`);
    }
    // Keys
    //   Key: foo; Type string
    //   Key: bar; Type string
    //   Key: 2; Type number
    //   Key: 10; Type string
    //   Key: baz.qux; Type string
    

    Full docs.

    Install

    npm i path-notation

    DownloadsWeekly Downloads

    0

    Version

    2.1.0

    License

    ISC

    Unpacked Size

    792 kB

    Total Files

    12

    Last publish

    Collaborators

    • avatar