Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@node-idempotency/express

mahendraHegde153MIT1.0.5TypeScript support: included

Express middleware to provide Race-Condition free idempotency for HTTP requests, preventing unintended duplicate operations.

express, express-middleware, node-idempotency, idempotency, deduplicate, request-idempotency, http-idempotency, api-idempotency, distributed-systems, request-deduplication, nodejs, request-deduplication, idempotent, safe operation, duplicate handling, request deduplication, retry with safety, at-least-once semantics, data consistency, idempotency-key, idempotency-key

readme

@node-idempotency/express

An Express middleware that makes requests idempotent Implements @node-idempotency/core as express middleware.


Why?


Network requests are unpredictable; clients/proxies may send duplicate or concurrent requests due to retries or network issues. To ensure smooth operation, servers must process each request only once. This package detects and handles duplicates, preventing issues like double charging the customer. It's:

  • Race Condition free: Ensures consistent behavior even during concurrent requests.
  • Modular: Easily integrates with your storage or existing implementation.(as simple as registering a middleware)
  • Customizable: options to tweak the library as per your need.
  • RFC compliant: Adheres to standards for compatibility with other systems/clients.

How?

No Image

instal
npm i @node-idempotency/express
usage
import * as express from "express";

//server.ts
export default async (): Promise<express.Application> => {
  const app = express();
  const middleware = await idempotencyAsMiddleware({
    storage:{
      adapter: StorageAdapterEnum.memory
      options: ...adapterOptions
    },
  ...idempotencyOptions
  });
  app.use(middleware);
  //register routes here
  app.use(errorHandler); //your custom error handler

  return app;
};
  • storage.adapter can either be memory, redis or an instance of Storage interface.
  • storage.options are options to the storage client, required for redis, is client options of redis client.
  • idempotencyOptions are the IdempotencyOptions passed to @node-idempotency/core/Idempotency