@whatwg-node/server 0.9.61-alpha-20241210212159-eb8dfa431df1774b9cc10381472ca880c4127e3a → 0.9.62-alpha-20241212140432-8fd4c16f9d3fb49c3275ef673a421204623bc3d9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@whatwg-node/server",
-  "version": "0.9.61-alpha-20241210212159-eb8dfa431df1774b9cc10381472ca880c4127e3a",
+  "version": "0.9.62-alpha-20241212140432-8fd4c16f9d3fb49c3275ef673a421204623bc3d9",
   "description": "Fetch API compliant HTTP Server adapter",
   "sideEffects": false,
   "dependencies": {

package/typings/plugins/types.d.cts

@@ -1,8 +1,35 @@
 import { FetchAPI, ServerAdapterRequestHandler, type ServerAdapterInitialContext } from '../types.cjs';
 export interface ServerAdapterPlugin<TServerContext = {}> {
+    /**
+     * This hook is invoked for ANY incoming HTTP request. Here you can manipulate the request,
+     * create a short circuit before the request handler takes it over.
+     *
+     * Warning: Exceptions thrown by this hook are not caught.
+     * This means they will buble up to the HTTP server underlying implementation.
+     * For example, the `node:http` server crashes the entire process on uncaught exceptions.
+     */
     onRequest?: OnRequestHook<TServerContext & ServerAdapterInitialContext>;
+    /**
+     * This hook is invoked after a HTTP request (both GraphQL and NON GraphQL) has been processed
+     * and after the response has been forwarded to the client. Here you can perform any cleanup
+     * or logging operations, or you can manipulate the outgoing response object.
+     *
+     * Warning: Exceptions thrown by this hook are not caught.
+     * This means they will buble up to the HTTP server underlying implementation.
+     * For example, the `node:http` server crashes the entire process on uncaught exceptions.
+     */
     onResponse?: OnResponseHook<TServerContext & ServerAdapterInitialContext>;
+    /**
+     * This hook is invoked when the server is being disposed.
+     * The server disposal is triggered either by the request termination or the explicit server disposal.
+     * @see https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-2.html
+     */
     [Symbol.dispose]?: () => void;
+    /**
+     * This hook is invoked when the server is being disposed.
+     * The server disposal is triggered either by the request termination or the explicit server disposal.
+     * @see https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-2.html
+     */
     [Symbol.asyncDispose]?: () => PromiseLike<void> | void;
 }
 export type OnRequestHook<TServerContext> = (payload: OnRequestEventPayload<TServerContext>) => Promise<void> | void;

package/typings/plugins/types.d.ts

@@ -1,8 +1,35 @@
 import { FetchAPI, ServerAdapterRequestHandler, type ServerAdapterInitialContext } from '../types.js';
 export interface ServerAdapterPlugin<TServerContext = {}> {
+    /**
+     * This hook is invoked for ANY incoming HTTP request. Here you can manipulate the request,
+     * create a short circuit before the request handler takes it over.
+     *
+     * Warning: Exceptions thrown by this hook are not caught.
+     * This means they will buble up to the HTTP server underlying implementation.
+     * For example, the `node:http` server crashes the entire process on uncaught exceptions.
+     */
     onRequest?: OnRequestHook<TServerContext & ServerAdapterInitialContext>;
+    /**
+     * This hook is invoked after a HTTP request (both GraphQL and NON GraphQL) has been processed
+     * and after the response has been forwarded to the client. Here you can perform any cleanup
+     * or logging operations, or you can manipulate the outgoing response object.
+     *
+     * Warning: Exceptions thrown by this hook are not caught.
+     * This means they will buble up to the HTTP server underlying implementation.
+     * For example, the `node:http` server crashes the entire process on uncaught exceptions.
+     */
     onResponse?: OnResponseHook<TServerContext & ServerAdapterInitialContext>;
+    /**
+     * This hook is invoked when the server is being disposed.
+     * The server disposal is triggered either by the request termination or the explicit server disposal.
+     * @see https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-2.html
+     */
     [Symbol.dispose]?: () => void;
+    /**
+     * This hook is invoked when the server is being disposed.
+     * The server disposal is triggered either by the request termination or the explicit server disposal.
+     * @see https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-2.html
+     */
     [Symbol.asyncDispose]?: () => PromiseLike<void> | void;
 }
 export type OnRequestHook<TServerContext> = (payload: OnRequestEventPayload<TServerContext>) => Promise<void> | void;