Have ideas to improve npm?Join in the discussion! »

    sort-keys
    TypeScript icon, indicating that this package has built-in type declarations

    5.0.0 • Public • Published

    sort-keys

    Sort the keys of an object

    Useful to get a deterministically ordered object, as the order of keys can vary between engines.

    Install

    $ npm install sort-keys
    

    Usage

    import sortKeys from 'sort-keys';
    
    sortKeys({c: 0, a: 0, b: 0});
    //=> {a: 0, b: 0, c: 0}
    
    sortKeys({b: {b: 0, a: 0}, a: 0}, {deep: true});
    //=> {a: 0, b: {a: 0, b: 0}}
    
    sortKeys({b: [{b: 0, a: 0}], a: 0}, {deep: true});
    //=> {a: 0, b: [{a: 0, b: 0}]}
    
    sortKeys({c: 0, a: 0, b: 0}, {
    	compare: (a, b) => -a.localeCompare(b)
    });
    //=> {c: 0, b: 0, a: 0}
    
    sortKeys([{b: 0, a:2}], {deep: true});
    //=> [{a: 2, b: 0}]

    API

    sortKeys(object, options?)

    Returns a new object with sorted keys.

    object

    Type: object | Array

    options

    Type: object

    deep

    Type: boolean
    Default: false

    Recursively sort keys, including keys of objects inside arrays.

    compare

    Type: Function

    Compare function.


    Get professional support for this package with a Tidelift subscription
    Tidelift helps make open source sustainable for maintainers while giving companies
    assurances about security, maintenance, and licensing for their dependencies.

    Install

    npm i sort-keys

    DownloadsWeekly Downloads

    17,255,762

    Version

    5.0.0

    License

    MIT

    Unpacked Size

    5.94 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar