syncguard/firestore/index.d.ts

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

import type { Firestore } from "@google-cloud/firestore";
import type { LockFunction } from "../common/backend.js";
import type { FirestoreBackendOptions } from "./types.js";
/**
 * Creates a distributed lock function using Firestore backend
 * @param db Firestore instance
 * @param options Backend-specific configuration options
 * @returns Lock function with automatic and manual operations
 */
export declare function createLock(db: Firestore, options?: FirestoreBackendOptions): LockFunction;
export { createFirestoreBackend } from "./backend.js";
export type { FirestoreBackendOptions, FirestoreConfig, LockDocument, } from "./types.js";