@rvoh/psychic 3.0.0 → 3.0.1

package/dist/cjs/src/controller/index.js

@@ -197,7 +197,10 @@ export default class PsychicController {
         };
     }
     /**
-     * Gets the HTTP request headers from the Express request object.
+     * Gets the HTTP request headers from the Koa ctx object.
+     * We recommend using the #header method instead when looking
+     * to retreive the value for a specific header, since that method
+     * will be safe with regards to case sensitivity.
      *
      * @returns The request headers as a key-value object where header names are lowercase strings
      * and values can be strings, string arrays, or undefined.
@@ -216,6 +219,16 @@ export default class PsychicController {
     get headers() {
         return this.ctx.request.headers;
     }
+    /**
+     * returns the value for the requested header. This method is case insensitive.
+     * If the header requested is not found, a blank string is returned.
+     *
+     * @param headerName - the name of the header
+     * @returns string
+     */
+    header(headerName) {
+        return this.ctx.request.get(headerName);
+    }
     /**
      * Gets the combined parameters from the HTTP request. This includes URL parameters,
      * request body, and query string parameters merged together. The merge order is:

package/dist/esm/src/controller/index.js

@@ -197,7 +197,10 @@ export default class PsychicController {
         };
     }
     /**
-     * Gets the HTTP request headers from the Express request object.
+     * Gets the HTTP request headers from the Koa ctx object.
+     * We recommend using the #header method instead when looking
+     * to retreive the value for a specific header, since that method
+     * will be safe with regards to case sensitivity.
      *
      * @returns The request headers as a key-value object where header names are lowercase strings
      * and values can be strings, string arrays, or undefined.
@@ -216,6 +219,16 @@ export default class PsychicController {
     get headers() {
         return this.ctx.request.headers;
     }
+    /**
+     * returns the value for the requested header. This method is case insensitive.
+     * If the header requested is not found, a blank string is returned.
+     *
+     * @param headerName - the name of the header
+     * @returns string
+     */
+    header(headerName) {
+        return this.ctx.request.get(headerName);
+    }
     /**
      * Gets the combined parameters from the HTTP request. This includes URL parameters,
      * request body, and query string parameters merged together. The merge order is:

package/dist/types/src/controller/index.d.ts

@@ -111,7 +111,10 @@ export default class PsychicController {
         action: string;
     });
     /**
-     * Gets the HTTP request headers from the Express request object.
+     * Gets the HTTP request headers from the Koa ctx object.
+     * We recommend using the #header method instead when looking
+     * to retreive the value for a specific header, since that method
+     * will be safe with regards to case sensitivity.
      *
      * @returns The request headers as a key-value object where header names are lowercase strings
      * and values can be strings, string arrays, or undefined.
@@ -128,6 +131,14 @@ export default class PsychicController {
      * ```
      */
     get headers(): import("http").IncomingHttpHeaders;
+    /**
+     * returns the value for the requested header. This method is case insensitive.
+     * If the header requested is not found, a blank string is returned.
+     *
+     * @param headerName - the name of the header
+     * @returns string
+     */
+    header(headerName: string): string;
     /**
      * Gets the combined parameters from the HTTP request. This includes URL parameters,
      * request body, and query string parameters merged together. The merge order is:

package/package.json

@@ -2,7 +2,7 @@
   "type": "module",
   "name": "@rvoh/psychic",
   "description": "Typescript web framework",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "author": "RVOHealth",
   "repository": {
     "type": "git",