From 7caafd711839caa5807a3c2f01da9c7645e06669 Mon Sep 17 00:00:00 2001
From: ivstiv <ivstiv@users.noreply.github.com>
Date: Tue, 11 Jul 2023 23:24:46 +0100
Subject: [PATCH] Adding typescript declaration

---
 index.d.ts | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 index.d.ts

diff --git a/index.d.ts b/index.d.ts
new file mode 100644
index 0000000..03fb493
--- /dev/null
+++ b/index.d.ts
@@ -0,0 +1,31 @@
+declare module "redfour" {
+
+  interface LockOptions {
+    redis: any // the parameters of createClient from redis are untyped?
+    namespace?: string
+  }
+
+  interface LockObject {
+    id: string
+    success: boolean
+    index: string
+    result: any
+  }
+
+  interface AcquiredLockObject {
+    id: string  
+    success: boolean
+    index: string
+    ttl: number
+  }
+
+  class Lock {
+    constructor(options: LockOptions);
+    acquireLock(id: string, ttl: number): Promise<AcquiredLockObject>
+    releaseLock(lock: Lock): Promise<LockObject>
+    waitAcquireLock(id: string, lockTtl: number, waitTtl: number): Promise<AcquiredLockObject & { immediate: boolean }>
+    renewLock(lock: {id: string, index: string}, ttl: number): Promise<LockObject>
+  }
+
+  export = Lock
+}
\ No newline at end of file