@node-idempotency/fastify
v1.0.5
Published
fastify plugin that provides Race-Condition free idempotency for HTTP requests, preventing unintended duplicate operations.
Downloads
549
Maintainers
Keywords
Readme
@node-idempotency/fastify
A Fastify plugin that makes requests idempotent
Implements @node-idempotency/core
as fastify plugin.
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 plugin to fastify)
- Customizable: options to tweak the library as per your need.
- RFC compliant: Adheres to standards for compatibility with other systems/clients.
How?
instal
npm i @node-idempotency/fastify
usage
import fastify from "fastify";
import fp from "fastify-plugin";
import {
idempotencyAsPlugin,
type IdempotencyPluginOptions,
StorageAdapterEnum,
} from "@node-idempotency/fastify";
const server = fastify();
server.register(fp<IdempotencyPluginOptions>(idempotencyAsPlugin), {
storage:{
adapter: StorageAdapterEnum.memory
options: ...adapterOptions
},
//...IdempotencyOptions
});
//...your rest of logic
export default server;
storage.adapter
can either bememory
,redis
or an instance ofStorage
interface.storage.options
are options to the storage client, required forredis
, is client options of redis client.idempotencyOptions
are theIdempotencyOptions
passed to@node-idempotency/core/Idempotency