Merge pull request #35 from silwalanish/implement-short-id

Add implementation to get short id

Author: kabirbaidhya

README.md

@@ -227,6 +227,18 @@ Example: If used in express, it returns unique store id per request.
 const requestIdentifier = store.getId();
 ```
 
+### getShortId()
+
+Gets the short unique store id created for the current context/scope.
+
+Note: This is same as `getId();` the difference being it only returns the first 8 characters.
+
+- `@returns {string | undefined}` - Returns the short unique store id.
+
+```js
+const requestIdentifier = store.getShortId();
+```
+
 ## Changelog
 
 Check the [CHANGELOG](CHANGELOG.md) for release history.

src/AsyncStore.ts

@@ -12,6 +12,7 @@ interface AsyncStore {
   find: (key: string) => any;
   isInitialized: () => boolean;
   getId: () => string | undefined;
+  getShortId: () => string | undefined;
 }
 
 export default AsyncStore;

src/impl/domain.ts

@@ -234,6 +234,19 @@ export function getId(): string | undefined {
   return activeDomain && activeDomain[ID_KEY];
 }
 
+/**
+ * Gets the short unique domain id created for the current context / scope.
+ *
+ * Note: This is same as `getId();` the difference being it only returns the first 8 characters.
+ *
+ * @returns {(string | undefined)}
+ */
+export function getShortId(): string | undefined {
+  const id = getId();
+
+  return id && id.substring(0, 8);
+}
+
 /**
  * Get the store from the active domain.
  *

src/index.ts

@@ -199,6 +199,17 @@ export function getId(): string | undefined {
   return initializedAdapter && getInstance(initializedAdapter).getId();
 }
 
+/**
+ * Gets the short unique domain id created for the current context / scope.
+ *
+ * Note: This is same as `getId();` the difference being it only returns the first 8 characters.
+ *
+ * @returns {(string | undefined)}
+ */
+export function getShortId(): string | undefined {
+  return initializedAdapter && getInstance(initializedAdapter).getShortId();
+}
+
 /**
  * Get the adapter instance based on adapter type.
  *

test/domain.test.ts

@@ -212,6 +212,28 @@ describe('store: [adapter=DOMAIN]', () => {
     });
   });
 
+  describe('getShortId()', () => {
+    it('should return short (8 chars) unique value if store is initialized.', done => {
+      const callback = () => {
+        expect(globalStore.getShortId()).to.be.an('string');
+        expect(globalStore.getShortId()).to.not.equal(null);
+        expect(globalStore.getShortId()).to.not.equal(undefined);
+        expect(globalStore.getShortId()).to.be.lengthOf(8);
+
+        done();
+      };
+
+      globalStore.initialize(adapter)(callback);
+    });
+
+    it('should return `undefined` if store is not initialized.', done => {
+      expect(globalStore.getShortId).to.not.throw();
+      expect(globalStore.getShortId()).to.equal(undefined);
+
+      done();
+    });
+  });
+
   describe('find()', () => {
     it('should successfully return value in synchronous callback.', done => {
       const callback = () => {