ssr-serialize-javascript - npm Package Compare versions

Comparing version 6.0.0 to 6.0.1

index.d.ts

+// Type definitions for serialize-javascript 5.0
+// Project: https://github.com/yahoo/serialize-javascript
+// Definitions by: Pochodaydayup <https://github.com/Pochodaydayup>
+//                 undefined-moe <https://github.com/undefined-moe>
+//                 Piotr Błażejewicz <https://github.com/peterblazejewicz>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+declare namespace serializeJavascript {
+  interface SerializeJSOptions {
+      /**
+       * This option is the same as the space argument that can be passed to JSON.stringify.
+       * It can be used to add whitespace and indentation to the serialized output to make it more readable.
+       */
+      space?: string | number | undefined;
+      /**
+       * This option is a signal to serialize() that the object being serialized does not contain any function or regexps values.
+       * This enables a hot-path that allows serialization to be over 3x faster.
+       * If you're serializing a lot of data, and know its pure JSON, then you can enable this option for a speed-up.
+       */
+      isJSON?: boolean | undefined;
+      /**
+       * This option is to signal serialize() that we want to do a straight conversion, without the XSS protection.
+       * This options needs to be explicitly set to true. HTML characters and JavaScript line terminators will not be escaped.
+       * You will have to roll your own.
+       */
+      unsafe?: true | undefined;
+      /**
+       * This option is to signal serialize() that we do not want serialize JavaScript function.
+       * Just treat function like JSON.stringify do, but other features will work as expected.
+       */
+      ignoreFunction?: boolean | undefined;
+  }
+}
+
+/**
+* Serialize JavaScript to a superset of JSON that includes regular expressions and functions.
+* @param input data to serialize
+* @param options optional object
+* @returns serialized data
+*/
+declare function serialize(
+  input: any,
+  options?: serializeJavascript.SerializeJSOptions | number | string,
+): string;
+
+export { serialize }

package.json

 {
   "name": "ssr-serialize-javascript",
-  "version": "6.0.0",
+  "version": "6.0.1",
   "description": "Serialize JavaScript to a superset of JSON that includes regular expressions and functions.",
   "main": "index.js",
   "module": "esm.js",
+  "types": "index.d.ts",
   "scripts": {
@@ -8,0 +9,0 @@ "benchmark": "node -v && node test/benchmark/serialize.js",

No alert changes

Improved metrics

Total package byte prevSize

27503

8.16%

Number of package files

6

20%

Lines of code

476

9.68%

No dependency changes