@node-idempotency/express
TypeScript icon, indicating that this package has built-in type declarations

1.0.5 • Public • Published

@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

Package Sidebar

Install

npm i @node-idempotency/express

Weekly Downloads

58

Version

1.0.5

License

MIT

Unpacked Size

40.6 kB

Total Files

39

Last publish

Collaborators

  • maehendra9