@oncely/redis

@oncely/redis

Redis storage adapter for oncely using ioredis.

Installation

npm install @oncely/core @oncely/redis ioredis

Quick Start

import { redis } from '@oncely/redis';
import { express as idempotent } from '@oncely/express';

// From environment variable (ONCELY_REDIS_URL)
app.post('/orders', idempotent({ storage: redis() }), handler);

Configuration

import { redis } from '@oncely/redis';

// From environment variable
const storage = redis();

// From URL (password in URL)
const storage = redis('redis://:password@localhost:6379');

// With options
const storage = redis({
  url: 'redis://localhost:6379',
  keyPrefix: 'myapp:idem:',
});

// With existing ioredis client
import Redis from 'ioredis';
const client = new Redis({ host: 'localhost', password: 'secret' });
const storage = redis({ client });

Environment Variables

Variable	Description
ONCELY_REDIS_URL	Redis connection URL (e.g., redis://:password@host:6379)

Redis Cluster

import Redis from 'ioredis';
import { redis } from '@oncely/redis';

const cluster = new Redis.Cluster([
  { host: 'node1.example.com', port: 6379 },
  { host: 'node2.example.com', port: 6379 },
]);

const storage = redis({ client: cluster });

AWS ElastiCache

const storage = redis('redis://your-cluster.cache.amazonaws.com:6379');

Usage with Express

import { express as idempotent, configure } from '@oncely/express';
import { redis } from '@oncely/redis';

const idempotent = configure({
  storage: redis(),
  ttl: '1h',
});

app.post('/orders', idempotent(), orderHandler);
app.post('/payments', idempotent({ required: true }), paymentHandler);

Usage with Next.js

import { next } from '@oncely/next';
import { redis } from '@oncely/redis';

export const POST = next({ storage: redis() })(handler);

Key Prefix

All keys are prefixed with oncely: by default. Customize with:

const storage = redis({ keyPrefix: 'myapp:idem:' });

License

MIT