@types/sort-json

Installation

npm install --save @types/sort-json

Summary

This package contains type definitions for sort-json (https://github.com/kesla/sort-json).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/sort-json.

index.d.ts

declare namespace visit {
    interface VisitOptions {
        /**
         * Depth's level sorting keys on a multidimensional object
         * (default: `Infinity`)
         */
        depth?: number | undefined;
        /**
         * When sorting keys, converts all keys to lowercase so that
         * capitalization doesn't interfere with sort order (default: `false`)
         */
        ignoreCase?: boolean | undefined;
        /** Default: `1` */
        level?: number | undefined;
        /** Reverse the ordering z -> a (default: `false`) */
        reverse?: boolean | undefined;
    }

    interface OverwriteOptions extends VisitOptions {
        /**
         * Formats the file content with an indentation of spaces. Use a number
         * greater then 0 for the value (default: detects the used indentation
         * of the file)
         */
        indentSize?: number | undefined;
        /** Default: `false` */
        noFinalNewLine?: boolean | undefined;
    }

    /**
     * Sorts the JSON files with the `visit()` function and then overwrites the
     * file with sorted JSON
     * @param absolutePaths
     * * String: Absolute path to JSON file to sort and overwrite
     * * Array: Absolute paths to JSON files to sort and overwrite
     */
    function overwrite(absolutePaths: string | string[], options?: OverwriteOptions): any;
}

/**
 * Sorts the keys on objects
 * @param old An object to sort the keys of, if not object just returns whatever
 * was given
 */
declare function visit<T>(old: T, options?: visit.VisitOptions): T;

export = visit;

Additional Details

• Last updated: Tue, 07 Nov 2023 15:11:36 GMT
• Dependencies: none

Credits

These definitions were written by Florian Keller.