silgi 0.42.5 → 0.43.0

package/dist/types/hooks.d.mts

@@ -0,0 +1,37 @@
+import { HookResult } from "./helper.mjs";
+import { SilgiEvent } from "./event.mjs";
+import { ModuleHookContext } from "./module.mjs";
+import { MiddlewareSetup } from "./middleware.mjs";
+import { CaptureError } from "./runtime/silgi.mjs";
+import { Silgi } from "./silgi.mjs";
+
+//#region src/types/hooks.d.ts
+
+// export interface SilgiRuntimeHooks {}
+/**
+* The listeners to Silgi
+*/
+interface SilgiRuntimeHooks {
+  /**
+  * Called after Silgi initialization, when the Silgi instance is ready to work.
+  * @param silgi The configured Silgi object
+  * @returns Promise
+  */
+  "ready": (silgi: Silgi) => HookResult;
+  /**
+  * Called when silgi instance is gracefully closing.
+  * @param silgi The configured silgi object
+  * @returns Promise
+  */
+  "close": (silgi: Silgi) => HookResult;
+  "middleware:global:on": (event: SilgiEvent, setup: MiddlewareSetup) => HookResult;
+  "middleware:router:on": (event: SilgiEvent, setup: MiddlewareSetup) => HookResult;
+  "request:on": (event: SilgiEvent) => HookResult;
+  "fetch:before": (context: ModuleHookContext) => HookResult;
+  "fetch:after": (context: ModuleHookContext) => HookResult;
+  "fetch:error": (context: ModuleHookContext) => HookResult;
+  "fetch:finally": (context: Omit<ModuleHookContext, "event">) => HookResult;
+  "error": CaptureError;
+}
+//#endregion
+export { SilgiRuntimeHooks };