Merge pull request #95 from js-thing/issue_94

j-a-k-git · web-flow · commit e1cd649eacbe · 2021-05-23T16:28:25.000+05:30
added new helper function: getStatusCode
diff --git a/src/helpers/getReasonPhrase.spec.ts b/src/helpers/getReasonPhrase.spec.ts
@@ -5,9 +5,15 @@ import { HttpReasonPhrases } from '../HttpReasonPhrases';
 
 describe('getReasonPhrase', function () {
     it('# Returns the corresponding reason phrase for a valid defined status code', function () {
-        expect(getReasonPhrase(HttpStatusCodes.Ok)).to.equal(
-            HttpReasonPhrases.Ok
-        );
+        Object.entries(HttpStatusCodes).forEach((statusCodeKeyVal) => {
+            if (typeof statusCodeKeyVal[1] === 'number') {
+                expect(getReasonPhrase(statusCodeKeyVal[1])).to.equal(
+                    (HttpReasonPhrases as { [key: string]: string })[
+                        statusCodeKeyVal[0]
+                    ]
+                );
+            }
+        });
     });
     it('# Returns undefined for non-existent status code', function () {
         expect(getReasonPhrase(579)).to.equal(undefined);
diff --git a/src/helpers/getStatusCode.spec.ts b/src/helpers/getStatusCode.spec.ts
@@ -0,0 +1,27 @@
+import { expect } from 'chai';
+import getStatusCode from './getStatusCode';
+import { HttpStatusCodes } from '../HttpStatusCodes';
+import { HttpReasonPhrases } from '../HttpReasonPhrases';
+
+describe('getStatusCode', function () {
+    it('# Returns the corresponding status code for a valid defined reason phrase', function () {
+        Object.entries(HttpReasonPhrases).forEach((reasonPhraseKeyVal) => {
+            expect(getStatusCode(reasonPhraseKeyVal[1])).to.equal(
+                (HttpStatusCodes as { [key: string]: number | string })[
+                    reasonPhraseKeyVal[0]
+                ]
+            );
+            expect(
+                getStatusCode(reasonPhraseKeyVal[1].toUpperCase(), true)
+            ).to.equal(
+                (HttpStatusCodes as { [key: string]: number | string })[
+                    reasonPhraseKeyVal[0]
+                ]
+            );
+        });
+    });
+    it('# Returns undefined for non-existent reason phrase', function () {
+        expect(getStatusCode('')).to.equal(undefined);
+        expect(getStatusCode('hello')).to.equal(undefined);
+    });
+});
diff --git a/src/helpers/getStatusCode.ts b/src/helpers/getStatusCode.ts
@@ -0,0 +1,34 @@
+import { HttpStatusCodes } from '../HttpStatusCodes';
+import { HttpReasonPhrases } from '../HttpReasonPhrases';
+
+/**
+ * Get the status code for a given reason phrase.
+ * Optionally pass a second parameter to ignore case.
+ *
+ * @param reasonPhrase - e.g. OK
+ * @param ignoreCase - ignore case while comparing, default: false
+ * @returns - The corresponding status code as `number` for the given input `undefined` otherwise
+ */
+export default (
+    reasonPhrase: string,
+    ignoreCase = false
+): number | undefined => {
+    if (!reasonPhrase) {
+        return undefined;
+    }
+    const foundReasonKeyVal = Object.entries(
+        HttpReasonPhrases as { [key: string]: string }
+    ).find((reasonKeyVal) => {
+        if (ignoreCase) {
+            return reasonKeyVal[1].toLowerCase() === reasonPhrase.toLowerCase();
+        }
+        return reasonKeyVal[1] === reasonPhrase;
+    });
+    if (!foundReasonKeyVal) {
+        return undefined;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    return ((<any>HttpStatusCodes) as { [key: string]: number })[
+        foundReasonKeyVal[0]
+    ];
+};
diff --git a/src/helpers/index.ts b/src/helpers/index.ts
@@ -3,5 +3,6 @@ export * from './isSuccessStatus';
 export * from './isRedirectionStatus';
 export * from './isClientErrorStatus';
 export * from './isServerErrorStatus';
+export { default as getStatusCode } from './getStatusCode';
 export { default as getReasonPhrase } from './getReasonPhrase';
 export { default as getCompositeStatus } from './getCompositeStatus';
