fast-json-stringify 5.4.1 → 5.6.0

package/.github/workflows/benchmark.yml

@@ -71,7 +71,7 @@ jobs:
       pull-requests: write
     steps:
       - name: Comment PR
-        uses: thollander/actions-comment-pull-request@v1
+        uses: thollander/actions-comment-pull-request@v2
         with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           message: |

package/.taprc

@@ -1,9 +1,14 @@
 ts: false
 jsx: false
+
 branches: 65
 functions: 100
 lines: 89
 statements: 89
+
 nyc-arg:
   - "--exclude=.cache/*"
   - "--exclude=lib/schema-validator.js"
+
+files:
+  - test/**/*.test.js

package/README.md

@@ -548,7 +548,7 @@ By default the library will handle automatically [BigInt](https://developer.mozi
 <a name="integer"></a>
 #### Integers
 The `type: integer` property will be truncated if a floating point is provided.
-You can customize this behaviour with the `rounding` option that will accept [`round`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/round), [`ceil`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/ceil) or [`floor`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/floor):
+You can customize this behaviour with the `rounding` option that will accept [`round`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/round), [`ceil`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/ceil), [`floor`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/floor) or [`trunc`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/trunc). Default is `trunc`:
 
 ```js
 const stringify = fastJson(schema, { rounding: 'ceil' })
@@ -650,12 +650,16 @@ AJV Serialize large array x 58.76 ops/sec ±4.59% (60 runs sampled)
 Treat the schema definition as application code, it
 is not safe to use user-provided schemas.
 
-In order to achieve lowest cost/highest performance redaction `fast-json-stringify`
+To achieve low cost and high performance redaction `fast-json-stringify`
 creates and compiles a function (using the `Function` constructor) on initialization.
 While the `schema` is currently validated for any developer errors,
 there is no guarantee that supplying user-generated schema could not
 expose your application to remote attacks.
 
+Users are responsible for sending trusted data. `fast-json-stringify` guarantees that you will get
+a valid output only if your input matches the schema or can be coerced to the schema. If your input
+doesn't match the schema, you will get undefined behavior. 
+
 <a name="debug"></a>
 ### Debug Mode
 

package/benchmark/bench.js

@@ -214,6 +214,27 @@ const benchmarks = [
       b5: true
     }
   },
+  {
+    name: 'simple object',
+    schema: {
+      title: 'Example Schema',
+      type: 'object',
+      properties: {
+        firstName: {
+          type: 'string'
+        },
+        lastName: {
+          type: ['string', 'null']
+        },
+        age: {
+          description: 'Age in years',
+          type: 'integer',
+          minimum: 0
+        }
+      }
+    },
+    input: { firstName: 'Max', lastName: 'Power', age: 22 }
+  },
   {
     name: 'object with const string property',
     schema: {