syncguard/redis/config.d.ts

Functional TypeScript library for distributed locking across microservices. Prevents race conditions with Redis, PostgreSQL, Firestore, and custom backends. Features automatic lock management, timeout handling, and extensible architecture.

import type { RedisBackendOptions, RedisConfig } from "./types.js";
/**
 * Default configuration for Redis backend.
 * @see docs/specs/redis-backend.md
 */
export declare const REDIS_DEFAULTS: {
    /** Key prefix for Redis lock entries */
    readonly keyPrefix: "syncguard";
    /** Cleanup expired locks in isLocked() - disabled for O(1) performance */
    readonly cleanupInIsLocked: false;
};
/**
 * Merges user options with defaults and validates configuration.
 * @param options - User-provided Redis configuration
 * @returns Complete Redis backend configuration
 * @throws {LockError} If keyPrefix configuration could result in fence counter deletion
 */
export declare function createRedisConfig(options?: RedisBackendOptions): RedisConfig;