Add delete functionality

Author: samirsilwal

README.md

@@ -342,8 +342,6 @@ Note: This is same as `getId();` the difference being it only returns the first
 const requestIdentifier = store.getShortId();
 ```
 
-
-
 ## Example Projects
 
 1. [Node Web Server (TypeScript)](examples/node-http-server-ts)

src/AsyncStore.ts

@@ -14,6 +14,7 @@ interface AsyncStore {
   getId: () => string | undefined;
   getShortId: () => string | undefined;
   reset: () => void;
+  del: (key: string) => void;
 }
 
 export default AsyncStore;

src/impl/domain.ts

@@ -109,6 +109,23 @@ export function reset() {
   activeDomain[STORE_KEY] = null;
 }
 
+/**
+ * Delete a key from the store.
+ *
+ * @param {string} key
+ */
+export function del(key: string) {
+  logDomain(`Deleting ${key} from the domain store.`);
+
+  const store = getStore();
+
+  if (!store) {
+    return;
+  }
+
+  delete store[key];
+}
+
 /**
  * Get a value by a key from the store.
  * Throws an error if anything fails while getting the value.

src/index.ts

@@ -129,6 +129,21 @@ export function reset() {
   getInstance(initializedAdapter).reset();
 }
 
+/**
+ * Delete a key from the store.
+ *
+ * @param {string} key
+ */
+export function del(key: string) {
+  if (!isInitialized()) {
+    throw new Error('Async store not initialized.');
+  }
+
+  coreLog(`Deleting ${key} from the store`);
+
+  getInstance(initializedAdapter).del(key);
+}
+
 /**
  * Sets properties in the store.
  *

test/domain.test.ts

@@ -8,6 +8,7 @@ import * as globalStore from '../src';
 import Middleware from '../src/Middleware';
 import { STORE_KEY } from '../src/StoreDomain';
 import AsyncStoreAdapter from '../src/AsyncStoreAdapter';
+import { getActiveDomain } from '../src/impl/domain';
 
 describe('store: [adapter=DOMAIN]', () => {
   const adapter = AsyncStoreAdapter.DOMAIN;
@@ -503,6 +504,47 @@ describe('store: [adapter=DOMAIN]', () => {
       globalStore.reset();
 
       expect(globalStore.isInitialized()).to.equal(false);
+
+      const activeDomain = getActiveDomain();
+      expect(activeDomain[STORE_KEY]).to.equal(null);
+    });
+  });
+
+  describe('del():', () => {
+    it('should delete a key from the store.', (done) => {
+      const callback = () => {
+        globalStore.set({ foo: 'foo', bar: 'bar' });
+
+        expect(globalStore.get('foo')).to.equal('foo');
+        expect(globalStore.get('bar')).to.equal('bar');
+
+        globalStore.del('foo');
+
+        expect(globalStore.get('foo')).to.equal(undefined);
+        expect(globalStore.get('bar')).to.equal('bar');
+
+        done();
+      };
+
+      globalStore.initialize(adapter)(callback);
+    });
+
+    it('should do nothing if the key does not exist.', (done) => {
+      const callback = () => {
+        globalStore.set({ foo: 'foo', bar: 'bar' });
+
+        expect(globalStore.get('foo')).to.equal('foo');
+        expect(globalStore.get('bar')).to.equal('bar');
+
+        globalStore.del('baz');
+
+        expect(globalStore.get('foo')).to.equal('foo');
+        expect(globalStore.get('bar')).to.equal('bar');
+
+        done();
+      };
+
+      globalStore.initialize(adapter)(callback);
     });
   });