Installation

npm install --save @types/json-stable-stringify

Summary

This package contains type definitions for json-stable-stringify (https://github.com/substack/json-stable-stringify).

Details

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

index.d.ts

/**
 * Deterministic version of JSON.stringify() so you can get a consistent hash from stringified results.
 *
 * @returns Deterministic json result.
 */
declare function stringify(obj: any, opts?: stringify.Comparator | stringify.Options): string;

declare namespace stringify {
    interface Element {
        key: string;
        value: any;
    }

    type Comparator = (a: Element, b: Element) => number;

    type Replacer = (key: string, value: any) => any;

    interface Options {
        /**
         * Custom comparator for key
         */
        cmp?: Comparator;

        /**
         * Indent the output for pretty-printing.
         *
         * Supported is either a string or a number of spaces.
         */
        space?: string | number;

        /**
         * Option to replace values to simpler values
         */
        replacer?: Replacer;

        /**
         * true to allow cycles, by marking the entries as __cycle__.
         */
        cycles?: boolean;
    }
}

export = stringify;

Additional Details

Last updated: Tue, 07 Nov 2023 03:09:37 GMT
Dependencies: none

Credits

These definitions were written by Matt Frantz.

Current Tags

18 Versions

1.0.36 ... 2 years ago
1.0.35 ... 2 years ago
1.0.34 ... 4 years ago
1.0.33 ... 5 years ago
1.0.32 ... 9 years ago
1.0.31 ... 9 years ago
1.0.30 ... 9 years ago
1.0.29 ... 10 years ago
1.0.28 ... 10 years ago
1.0.27-alpha ... 10 years ago
1.0.26-alpha ... 10 years ago
1.0.25-alpha ... 10 years ago
1.0.24-alpha ... 10 years ago
1.0.23-alpha ... 10 years ago
1.0.22-alpha ... 10 years ago
1.0.21-alpha ... 10 years ago
1.0.16-alpha ... 10 years ago
1.0.15-alpha ... 10 years ago