@types/json-stable-stringify - npm Package Compare versions

Comparing version 1.0.33 to 1.0.34

json-stable-stringify/index.d.ts

@@ -6,2 +6,7 @@ // Type definitions for json-stable-stringify 1.0
 
+/**
+ * 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;
@@ -20,5 +25,23 @@
     interface Options {
-        cmp?: Comparator | undefined;
-        space?: number | string | undefined;
-        replacer?: Replacer | undefined;
+        /**
+         * 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;
     }
@@ -25,0 +48,0 @@ }

json-stable-stringify/package.json

 {
     "name": "@types/json-stable-stringify",
-    "version": "1.0.33",
+    "version": "1.0.34",
     "description": "TypeScript definitions for json-stable-stringify",
@@ -23,4 +23,4 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/json-stable-stringify",
     "dependencies": {},
-    "typesPublisherContentHash": "09ae596403b72c11e892944ab9d3b9c8f772de92aa1a25221b936a48797ae23f",
-    "typeScriptVersion": "3.6"
+    "typesPublisherContentHash": "b03b67b40cb8df7cae098fb8752ccda5f6a695c8a959bf886e6a43daccde98be",
+    "typeScriptVersion": "3.9"
 }

json-stable-stringify/README.md

@@ -16,2 +16,7 @@ # Installation
 
+/**
+ * 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;
@@ -30,5 +35,23 @@
     interface Options {
-        cmp?: Comparator | undefined;
-        space?: number | string | undefined;
-        replacer?: Replacer | undefined;
+        /**
+         * 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;
     }
@@ -42,3 +65,3 @@ }
 ### Additional Details
- * Last updated: Tue, 06 Jul 2021 21:33:48 GMT
+ * Last updated: Wed, 02 Mar 2022 17:31:50 GMT
  * Dependencies: none
@@ -45,0 +68,0 @@ * Global values: none

No alert changes

Improved metrics

Total package byte prevSize

5180

increased by25.61%

Lines of code

39

increased by105.26%

Number of lines in readme file

69

increased by50%

No dependency changes