Merge pull request #19 from cybercoder-naj/feat/on-request

Feat: Optional OnRequest logging

Author: cybercoder-naj

CHANGELOG.md

@@ -1,4 +1,8 @@
 # CHANGELOG
+## [1.1.0] - 31-03-2024
+### Added
+- Optional `onRequest` logging formatter for hooking onto onRequest. ([#13](https://github.com/cybercoder-naj/logestic/issues/13))
+
 ## [1.0.1] - 30-03-2024
 ### Added
 - Type-safety to onSuccess method, based on attributes passed on `use`. ([#6](https://github.com/cybercoder-naj/logestic/issues/6))

package.json

@@ -1,6 +1,6 @@
 {
   "name": "logestic",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "author": "Nishant Aanjaney Jalan <[email protected]>",
   "description": "An advanced and customisable logging library for ElysiaJS",
   "keywords": [

src/index.ts

@@ -129,8 +129,16 @@ export class Logestic<K extends keyof Attribute = keyof Attribute> {
   format(this: Logestic, formatAttr: Callback<K>) {
     return this.build()
       .state('logestic_timeStart', 0n)
-      .onRequest(({ store }) => {
+      .onRequest(({ store, request }) => {
         store.logestic_timeStart = process.hrtime.bigint();
+
+        if (formatAttr.onRequest) {
+          let msg = formatAttr.onRequest(request);
+          if (this.showLevel) {
+            msg = `${colourLogType('http', this.logLevelColour)} ${msg}`;
+          }
+          this.log(msg);
+        }
       })
       .onResponse({ as: 'global' }, ctx => {
         if (!this.httpLogging) {

src/types.ts

@@ -36,6 +36,7 @@ export type Preset = 'common' | 'fancy';
  * `Callback` is an object that contains functions to format successful and failed logs.
  */
 export type Callback<K extends keyof Attribute> = {
+  onRequest?: (attr: Request) => string;
   onSuccess: (attr: Pick<Attribute, K>) => string;
   onFailure: (attr: ErrorAttribute) => string;
 };