express-fast-json-stringify 1.2.6 → 1.2.8

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [1.2.8](https://github.com/nigrosimone/express-fast-json-stringify/compare/v1.2.6...v1.2.8) (2024-09-29)
+
+
+### Bug Fixes
+
+* global type ([56fa47c](https://github.com/nigrosimone/express-fast-json-stringify/commit/56fa47c6b395a1de89dd85bc67f55c8cd3f5d852))
+
 ### [1.2.6](https://github.com/nigrosimone/express-fast-json-stringify/compare/v1.2.4...v1.2.6) (2024-09-29)
 
 

package/README.md

@@ -1,59 +1,24 @@
-# express-fast-json-stringify
+JSON serialization is a critical task in web development, particularly for applications built with Node.js and Express.js. While the native JSON serialization in Node.js (`JSON.stringify()`) is straightforward and convenient, it can become a performance bottleneck, especially under heavy load. This article introduces [express-fast-json-stringify](https://www.npmjs.com/package/express-fast-json-stringify), a custom middleware package that leverages [fast-json-stringify](https://www.npmjs.com/package/fast-json-stringify) to significantly boost JSON serialization performance in Express applications.
 
-One of the reasons why [Fastify](https://www.npmjs.com/package/fastify) is faster than Express is its use of [fast-json-stringify](https://www.npmjs.com/package/fast-json-stringify). `fast-json-stringify` is a library developed by the Fastify team that boosts JSON conversion speed by analyzing JSON schema definitions.
+## What is fast-json-stringify?
 
-By using the `fast-json-stringify` library, Fastify can serialize JSON much faster than Express, contributing to its overall performance advantage.
+`fast-json-stringify` is a JSON serialization library developed by the Fastify team. It enhances JSON conversion speed by analyzing JSON schema definitions and compiling them into highly optimized serialization functions. This makes it much faster than the native `JSON.stringify()`, particularly beneficial for high-performance applications.
 
-With `express-fast-json-stringify`, you can leverage `fast-json-stringify` in your Express application as follows:
+## Introducing express-fast-json-stringify
 
-```ts
-import express from 'express';
-import { fastJsonSchema, Schema } from 'express-fast-json-stringify';
+`express-fast-json-stringify` is an npm package that brings the performance benefits of `fast-json-stringify` to Express.js applications. By integrating this package, you can achieve faster JSON serialization, thus improving the overall performance of your application.
 
-const schema: Schema = {
-  title: 'Example Schema',
-  type: 'object',
-  properties: {
-    firstName: {
-      type: 'string',
-    },
-    lastName: {
-      type: 'string',
-    },
-    age: {
-      description: 'Age in years',
-      type: 'integer',
-    },
-  },
-};
+## Installation
 
-const app = express();
-
-app.get('/', fastJsonSchema(schema), (req, res, next) => {
-  try {
-    const data = {
-      firstName: 'Simone',
-      lastName: 'Nigro',
-      age: 40,
-    };
-    res.fastJson(data);
-  } catch (error) {
-    next(error);
-  }
-});
-```
-
-See the stackblitz [demo](https://stackblitz.com/edit/express-fast-json-stringify).
-
-## How to Use
-
-1. Install the package:
+First, install the `express-fast-json-stringify` package:
 
 ```
 npm install express-fast-json-stringify
 ```
 
-2. Create a schema object that defines the structure of your JSON response, eg.:
+## Creating a JSON Schema
+
+Define a schema object that specifies the structure of your JSON responses. This schema will be used by `fast-json-stringify` to optimize the serialization process.
 
 ```ts
 import { Schema } from 'express-fast-json-stringify';
@@ -62,12 +27,8 @@ const schema: Schema = {
   title: 'Example Schema',
   type: 'object',
   properties: {
-    firstName: {
-      type: 'string',
-    },
-    lastName: {
-      type: 'string',
-    },
+    firstName: { type: 'string' },
+    lastName: { type: 'string' },
     age: {
       description: 'Age in years',
       type: 'integer',
@@ -76,32 +37,36 @@ const schema: Schema = {
 };
 ```
 
-3. Apply the `fastJsonSchema` middleware to your Express route, passing in the schema object, eg.:
+## Applying the Middleware
+
+Use the `fastJsonSchema` middleware in your Express routes, passing the schema object as an argument. This will set up the optimized JSON serialization for that route.
 
 ```ts
+import express, { Request, Response, NextFunction } from 'express';
 import { fastJsonSchema, Schema } from 'express-fast-json-stringify';
 
-const schema: Schema = {
+const app = express();
+
+const exampleSchema: Schema = {
   title: 'Example Schema',
   type: 'object',
   properties: {
-    firstName: {
-      type: 'string',
-    },
-    lastName: {
-      type: 'string',
-    },
-    age: {
-      description: 'Age in years',
-      type: 'integer',
-    },
+    firstName: { type: 'string' },
+    lastName: { type: 'string' },
+    age: { type: 'integer' },
   },
 };
 
-app.get('/', fastJsonSchema(schema), (req, res, next) => {});
+app.get(
+  '/',
+  fastJsonSchema(exampleSchema),
+  (req: Request, res: Response, next: NextFunction) => {},
+);
 ```
 
-4. Send JSON Response: Use `res.fastJson()` to send your JSON response, leveraging the speed benefits of `fast-json-stringify`, eg.:
+## Sending JSON Responses
+
+Instead of using the default `res.json()` method, use the `res.fastJson()` method provided by the middleware to send JSON responses. This leverages the speed benefits of fast-json-stringify.
 
 ```ts
 import { fastJsonSchema, Schema } from 'express-fast-json-stringify';
@@ -110,12 +75,8 @@ const schema: Schema = {
   title: 'Example Schema',
   type: 'object',
   properties: {
-    firstName: {
-      type: 'string',
-    },
-    lastName: {
-      type: 'string',
-    },
+    firstName: { type: 'string' },
+    lastName: { type: 'string' },
     age: {
       description: 'Age in years',
       type: 'integer',
@@ -137,4 +98,16 @@ app.get('/', fastJsonSchema(schema), (req, res, next) => {
 });
 ```
 
-By following these steps, you can enhance the performance of your Express applications with faster JSON serialization.
+## Performance Benefits
+
+Using `express-fast-json-stringify` offers several performance benefits:
+
+1. **Increased Speed**: `fast-json-stringify` can serialize JSON data much faster than JSON.stringify(), especially for complex JSON objects.
+2. **Reduced CPU Usage**: Faster serialization means less CPU time spent on processing, allowing your server to handle more concurrent requests.
+3. **Consistency and Validation**: By defining JSON schemas, you ensure that the serialized data adheres to a predefined structure, improving data consistency and reducing the likelihood of errors.
+
+## Conclusion
+
+Integrating `express-fast-json-stringify` into your Express.js application can provide substantial performance improvements, especially in scenarios where JSON serialization is a bottleneck. By leveraging the power of `fast-json-stringify`, you can achieve faster response times and handle higher loads, making your application more efficient and scalable.
+
+To start using `express-fast-json-stringify`, follow the steps outlined in this article, and enjoy the benefits of faster JSON serialization in your Express applications. For a live demo, you can check out the [StackBlitz demo](https://stackblitz.com/edit/express-fast-json-stringify).

package/build/main/lib/middleware.d.ts

@@ -1,10 +1,11 @@
 import type { NextFunction, Request, Response } from 'express';
-import { Options, Schema } from 'fast-json-stringify';
+import { type Options, type Schema } from 'fast-json-stringify';
 export type { Schema, Options } from 'fast-json-stringify';
 /**
  * Set the schema
  * @param {Schema} schema The schema used to stringify values
  * @param {Options} options The options to use (optional)
+ * @see https://www.npmjs.com/package/fast-json-stringify
  *
  * Examples:
  * ```ts
@@ -44,3 +45,19 @@ export type { Schema, Options } from 'fast-json-stringify';
  * ```
  */
 export declare const fastJsonSchema: (schema: Schema, options?: Options) => (_req: Request, res: Response, next: NextFunction) => void;
+declare global {
+    namespace Express {
+        interface Response {
+            /**
+             * Send JSON response.
+             *
+             * Examples:
+             * ```ts
+             * res.fastJson({ user: 'tj' });
+             * res.status(200).fastJson({ user: 'tj' });
+             * ```
+             */
+            fastJson: (data: any) => Response;
+        }
+    }
+}

package/build/main/lib/middleware.js

@@ -9,6 +9,7 @@ const fast_json_stringify_1 = __importDefault(require("fast-json-stringify"));
  * Set the schema
  * @param {Schema} schema The schema used to stringify values
  * @param {Options} options The options to use (optional)
+ * @see https://www.npmjs.com/package/fast-json-stringify
  *
  * Examples:
  * ```ts
@@ -72,4 +73,4 @@ const fastJsonSchema = (schema, options) => {
     };
 };
 exports.fastJsonSchema = fastJsonSchema;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWlkZGxld2FyZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9saWIvbWlkZGxld2FyZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7QUFDQSw4RUFBZ0U7QUFJaEU7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0dBeUNHO0FBQ0ksTUFBTSxjQUFjLEdBQUcsQ0FBQyxNQUFjLEVBQUUsT0FBaUIsRUFBRSxFQUFFO0lBQ2xFLElBQUksQ0FBQyxNQUFNLEVBQUU7UUFDWCxNQUFNLElBQUksU0FBUyxDQUFDLDZDQUE2QyxDQUFDLENBQUM7S0FDcEU7SUFDRCxNQUFNLEdBQUcsR0FBRyxJQUFBLDZCQUFRLEVBQUMsTUFBTSxFQUFFLE9BQU8sQ0FBQyxDQUFDO0lBQ3RDLE9BQU8sQ0FBQyxJQUFhLEVBQUUsR0FBYSxFQUFFLElBQWtCLEVBQUUsRUFBRTtRQUMxRDs7Ozs7Ozs7V0FRRztRQUNILEdBQUcsQ0FBQyxRQUFRLEdBQUcsQ0FBQyxJQUFTLEVBQVksRUFBRTtZQUNyQyxJQUFJLENBQUMsR0FBRyxDQUFDLFNBQVMsQ0FBQyxjQUFjLENBQUMsRUFBRTtnQkFDbEMsR0FBRyxDQUFDLFNBQVMsQ0FBQyxjQUFjLEVBQUUsa0JBQWtCLENBQUMsQ0FBQzthQUNuRDtZQUNELE9BQU8sR0FBRyxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQztRQUM3QixDQUFDLENBQUM7UUFDRixJQUFJLEVBQUUsQ0FBQztJQUNULENBQUMsQ0FBQztBQUNKLENBQUMsQ0FBQztBQXZCVyxRQUFBLGNBQWMsa0JBdUJ6QiJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWlkZGxld2FyZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9saWIvbWlkZGxld2FyZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7QUFDQSw4RUFBMEU7QUFJMUU7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQTBDRztBQUNJLE1BQU0sY0FBYyxHQUFHLENBQUMsTUFBYyxFQUFFLE9BQWlCLEVBQUUsRUFBRTtJQUNsRSxJQUFJLENBQUMsTUFBTSxFQUFFO1FBQ1gsTUFBTSxJQUFJLFNBQVMsQ0FBQyw2Q0FBNkMsQ0FBQyxDQUFDO0tBQ3BFO0lBQ0QsTUFBTSxHQUFHLEdBQUcsSUFBQSw2QkFBUSxFQUFDLE1BQU0sRUFBRSxPQUFPLENBQUMsQ0FBQztJQUN0QyxPQUFPLENBQUMsSUFBYSxFQUFFLEdBQWEsRUFBRSxJQUFrQixFQUFFLEVBQUU7UUFDMUQ7Ozs7Ozs7O1dBUUc7UUFDSCxHQUFHLENBQUMsUUFBUSxHQUFHLENBQUMsSUFBUyxFQUFZLEVBQUU7WUFDckMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxTQUFTLENBQUMsY0FBYyxDQUFDLEVBQUU7Z0JBQ2xDLEdBQUcsQ0FBQyxTQUFTLENBQUMsY0FBYyxFQUFFLGtCQUFrQixDQUFDLENBQUM7YUFDbkQ7WUFDRCxPQUFPLEdBQUcsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUM7UUFDN0IsQ0FBQyxDQUFDO1FBQ0YsSUFBSSxFQUFFLENBQUM7SUFDVCxDQUFDLENBQUM7QUFDSixDQUFDLENBQUM7QUF2QlcsUUFBQSxjQUFjLGtCQXVCekIifQ==

package/build/module/lib/middleware.d.ts

@@ -1,10 +1,11 @@
 import type { NextFunction, Request, Response } from 'express';
-import { Options, Schema } from 'fast-json-stringify';
+import { type Options, type Schema } from 'fast-json-stringify';
 export type { Schema, Options } from 'fast-json-stringify';
 /**
  * Set the schema
  * @param {Schema} schema The schema used to stringify values
  * @param {Options} options The options to use (optional)
+ * @see https://www.npmjs.com/package/fast-json-stringify
  *
  * Examples:
  * ```ts
@@ -44,3 +45,19 @@ export type { Schema, Options } from 'fast-json-stringify';
  * ```
  */
 export declare const fastJsonSchema: (schema: Schema, options?: Options) => (_req: Request, res: Response, next: NextFunction) => void;
+declare global {
+    namespace Express {
+        interface Response {
+            /**
+             * Send JSON response.
+             *
+             * Examples:
+             * ```ts
+             * res.fastJson({ user: 'tj' });
+             * res.status(200).fastJson({ user: 'tj' });
+             * ```
+             */
+            fastJson: (data: any) => Response;
+        }
+    }
+}

package/build/module/lib/middleware.js

@@ -3,6 +3,7 @@ import fastJson from 'fast-json-stringify';
  * Set the schema
  * @param {Schema} schema The schema used to stringify values
  * @param {Options} options The options to use (optional)
+ * @see https://www.npmjs.com/package/fast-json-stringify
  *
  * Examples:
  * ```ts
@@ -65,4 +66,4 @@ export const fastJsonSchema = (schema, options) => {
         next();
     };
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWlkZGxld2FyZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9saWIvbWlkZGxld2FyZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFDQSxPQUFPLFFBQTZCLE1BQU0scUJBQXFCLENBQUM7QUFJaEU7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0dBeUNHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sY0FBYyxHQUFHLENBQUMsTUFBYyxFQUFFLE9BQWlCLEVBQUUsRUFBRTtJQUNsRSxJQUFJLENBQUMsTUFBTSxFQUFFO1FBQ1gsTUFBTSxJQUFJLFNBQVMsQ0FBQyw2Q0FBNkMsQ0FBQyxDQUFDO0tBQ3BFO0lBQ0QsTUFBTSxHQUFHLEdBQUcsUUFBUSxDQUFDLE1BQU0sRUFBRSxPQUFPLENBQUMsQ0FBQztJQUN0QyxPQUFPLENBQUMsSUFBYSxFQUFFLEdBQWEsRUFBRSxJQUFrQixFQUFFLEVBQUU7UUFDMUQ7Ozs7Ozs7O1dBUUc7UUFDSCxHQUFHLENBQUMsUUFBUSxHQUFHLENBQUMsSUFBUyxFQUFZLEVBQUU7WUFDckMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxTQUFTLENBQUMsY0FBYyxDQUFDLEVBQUU7Z0JBQ2xDLEdBQUcsQ0FBQyxTQUFTLENBQUMsY0FBYyxFQUFFLGtCQUFrQixDQUFDLENBQUM7YUFDbkQ7WUFDRCxPQUFPLEdBQUcsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUM7UUFDN0IsQ0FBQyxDQUFDO1FBQ0YsSUFBSSxFQUFFLENBQUM7SUFDVCxDQUFDLENBQUM7QUFDSixDQUFDLENBQUMifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWlkZGxld2FyZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9saWIvbWlkZGxld2FyZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFDQSxPQUFPLFFBQXVDLE1BQU0scUJBQXFCLENBQUM7QUFJMUU7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQTBDRztBQUNILE1BQU0sQ0FBQyxNQUFNLGNBQWMsR0FBRyxDQUFDLE1BQWMsRUFBRSxPQUFpQixFQUFFLEVBQUU7SUFDbEUsSUFBSSxDQUFDLE1BQU0sRUFBRTtRQUNYLE1BQU0sSUFBSSxTQUFTLENBQUMsNkNBQTZDLENBQUMsQ0FBQztLQUNwRTtJQUNELE1BQU0sR0FBRyxHQUFHLFFBQVEsQ0FBQyxNQUFNLEVBQUUsT0FBTyxDQUFDLENBQUM7SUFDdEMsT0FBTyxDQUFDLElBQWEsRUFBRSxHQUFhLEVBQUUsSUFBa0IsRUFBRSxFQUFFO1FBQzFEOzs7Ozs7OztXQVFHO1FBQ0gsR0FBRyxDQUFDLFFBQVEsR0FBRyxDQUFDLElBQVMsRUFBWSxFQUFFO1lBQ3JDLElBQUksQ0FBQyxHQUFHLENBQUMsU0FBUyxDQUFDLGNBQWMsQ0FBQyxFQUFFO2dCQUNsQyxHQUFHLENBQUMsU0FBUyxDQUFDLGNBQWMsRUFBRSxrQkFBa0IsQ0FBQyxDQUFDO2FBQ25EO1lBQ0QsT0FBTyxHQUFHLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDO1FBQzdCLENBQUMsQ0FBQztRQUNGLElBQUksRUFBRSxDQUFDO0lBQ1QsQ0FBQyxDQUFDO0FBQ0osQ0FBQyxDQUFDIn0=

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-fast-json-stringify",
-  "version": "1.2.6",
+  "version": "1.2.8",
   "description": "With express-fast-json-stringify, you can leverage fast-json-stringify in your Express application",
   "main": "build/main/index.js",
   "typings": "build/main/index.d.ts",