feat: rename method getExpiredRange to expiredRange

BREAKING CHANGE: The method `getExpiredRange` has been renamed to `expiredRange`. Update any usage of the old method name accordingly.
miftahDB · Jan 3, 2025 · 13070f5 · 13070f5
1 parent e991683
commit 13070f5
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -366,7 +366,7 @@ const firstUsersPage = db.pagination(10, 1, "user:%");
 const secondUsersPage = db.pagination(10, 2, "user:%");
 ```
 
-### `getExpiredRange`
+### `expiredRange`
 
 Returns an array of keys that have expired between the given start and end dates.
 
@@ -377,13 +377,9 @@ Returns an array of keys that have expired between the given start and end dates
 - **Returns**:
   - The result of the operation, includes an array of keys or an error if the operation failed.
 
-
 ```ts
 // Get the expired keys between two dates
-const result = db.getExpiredRange(
-  new Date("2023-01-01"),
-  new Date("2023-01-31")
-);
+const result = db.expiredRange(new Date("2023-01-01"), new Date("2023-01-31"));
 
 if (result.success) {
   console.log(result.data);

diff --git a/bun.lockb b/bun.lockb
diff --git a/src/base.ts b/src/base.ts
@@ -56,7 +56,7 @@ export abstract class BaseMiftahDB implements IMiftahDB {
       setExpire: this.db.prepare(SQL_STATEMENTS.SET_EXPIRE),
       keys: this.db.prepare(SQL_STATEMENTS.KEYS),
       pagination: this.db.prepare(SQL_STATEMENTS.PAGINATION),
-      getExpiredRange: this.db.prepare(SQL_STATEMENTS.GET_EXPIRED_RANGE),
+      expiredRange: this.db.prepare(SQL_STATEMENTS.GET_EXPIRED_RANGE),
       cleanup: this.db.prepare(SQL_STATEMENTS.CLEANUP),
       countKeys: this.db.prepare(SQL_STATEMENTS.COUNT_KEYS),
       countExpired: this.db.prepare(SQL_STATEMENTS.COUNT_EXPIRED),
@@ -208,15 +208,15 @@ export abstract class BaseMiftahDB implements IMiftahDB {
   }
 
   @SafeExecution
-  getExpiredRange(
+  expiredRange(
     start: Date | number,
     end: Date | number,
     pattern = "%"
   ): Result<string[]> {
     const startDate = getExpireDate(start);
     const endDate = getExpireDate(end);
 
-    const result = this.statements.getExpiredRange.all(
+    const result = this.statements.expiredRange.all(
       this.addNamespacePrefix(pattern),
       startDate,
       endDate

diff --git a/src/types.ts b/src/types.ts
@@ -233,14 +233,14 @@ export interface IMiftahDB<T extends MiftahValue = MiftahValue> {
    * @returns {Result<string[]>} An array of expired keys.
    * @example
    * // Get the expired keys between two dates
-   * const result = db.getExpiredRange(new Date("2023-01-01"), new Date("2023-01-31"));
+   * const result = db.expiredRange(new Date("2023-01-01"), new Date("2023-01-31"));
    * if (result.success) {
    *   console.log(result.data);
    * } else {
    *   console.error(result.error);
    * }
    */
-  getExpiredRange(
+  expiredRange(
     start: Date | number,
     end: Date | number,
     pattern?: string

diff --git a/tests/bun.test.ts b/tests/bun.test.ts
@@ -69,15 +69,15 @@ test("Pagination", () => {
   }
 });
 
-test("getExpiredRange", () => {
+test("expiredRange", () => {
   const db = createDB();
   db.set("key1", "value1", new Date("2023-01-01"));
   db.set("key2", "value2", new Date("2023-01-02"));
   db.set("key3", "value3", new Date("2023-01-03"));
   db.set("key4", "value4", new Date("2023-01-04"));
   db.set("key5", "value5", new Date("2023-01-05"));
 
-  const result = db.getExpiredRange(
+  const result = db.expiredRange(
     new Date("2023-01-02"),
     new Date("2023-01-04")
   );
@@ -348,7 +348,7 @@ test("Namespace Keys/Pagination", () => {
   }
 });
 
-test("Namespace getExpiredRange", () => {
+test("Namespace expiredRange", () => {
   const db = createDB();
   const users = db.namespace("users");
   users.set("123", "value1", new Date("2023-01-01"));
@@ -357,7 +357,7 @@ test("Namespace getExpiredRange", () => {
   users.set("101", "value4", new Date("2023-01-04"));
   users.set("135", "value5", new Date("2023-01-05"));
 
-  const result = users.getExpiredRange(
+  const result = users.expiredRange(
     new Date("2023-01-02"),
     new Date("2023-01-04")
   );

diff --git a/tests/node.test.ts b/tests/node.test.ts
@@ -71,15 +71,15 @@ describe("MiftahDB Node Tests", () => {
     }
   });
 
-  it("getExpiredRange", () => {
+  it("expiredRange", () => {
     const db = createDB();
     db.set("key1", "value1", new Date("2023-01-01"));
     db.set("key2", "value2", new Date("2023-01-02"));
     db.set("key3", "value3", new Date("2023-01-03"));
     db.set("key4", "value4", new Date("2023-01-04"));
     db.set("key5", "value5", new Date("2023-01-05"));
 
-    const result = db.getExpiredRange(
+    const result = db.expiredRange(
       new Date("2023-01-02"),
       new Date("2023-01-04")
     );
@@ -353,7 +353,7 @@ describe("MiftahDB Node Tests", () => {
     }
   });
 
-  it("Namespace getExpiredRange", () => {
+  it("Namespace expiredRange", () => {
     const db = createDB();
     const users = db.namespace("users");
     users.set("123", "value1", new Date("2023-01-01"));
@@ -362,7 +362,7 @@ describe("MiftahDB Node Tests", () => {
     users.set("101", "value4", new Date("2023-01-04"));
     users.set("135", "value5", new Date("2023-01-05"));
 
-    const result = users.getExpiredRange(
+    const result = users.expiredRange(
       new Date("2023-01-02"),
       new Date("2023-01-04")
     );