feat: add remove alias

unjs · Mar 5, 2024 · 1ee816f · 1ee816f
1 parent 76560ec
commit 1ee816f
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 1 deletion.
diff --git a/docs/1.guide/1.index.md b/docs/1.guide/1.index.md
@@ -126,9 +126,10 @@ await storage.removeItem("foo:bar", { removeMeta: true });
 // same as await storage.removeItem("foo:bar", true);
 ```
 
-You can also use the `del` alias:
+You can also use the `del` or `remove` aliases:
 
 ```js
+await storage.remove("foo:bar");
 await storage.del("foo:bar");
 ```
 

diff --git a/src/storage.ts b/src/storage.ts
@@ -453,6 +453,7 @@ export function createStorage<T extends StorageValue>(
     set: (key, value, opts = {}) => storage.setItem(key, value, opts),
     has: (key, opts = {}) => storage.hasItem(key, opts),
     del: (key, opts = {}) => storage.removeItem(key, opts),
+    remove: (key, opts = {}) => storage.removeItem(key, opts),
   };
 
   return storage;

diff --git a/src/types.ts b/src/types.ts
@@ -131,4 +131,5 @@ export interface Storage<T extends StorageValue = StorageValue> {
   set: Storage["setItem"];
   has: Storage["hasItem"];
   del: Storage["removeItem"];
+  remove: Storage["removeItem"];
 }
diff --git a/test/storage.test.ts b/test/storage.test.ts
@@ -169,5 +169,8 @@ describe("utils", () => {
     expect(await storage.keys()).toEqual(["foo"]);
     await storage.del("foo");
     expect(await storage.has("foo")).toBe(false);
+    await storage.setItem("bar", "baz");
+    await storage.remove("bar");
+    expect(await storage.has("bar")).toBe(false);
   });
 });