@eleven-am/pondsocket 0.1.84 → 0.1.85

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eleven-am/pondsocket",
-  "version": "0.1.84",
+  "version": "0.1.85",
   "description": "PondSocket is a fast simple socket server",
   "keywords": [
     "socket",

package/types.d.ts

@@ -1,6 +1,6 @@
 import { Server as HTTPServer, IncomingHttpHeaders } from 'http';
 
-import { ModuleMetadata } from '@nestjs/common/interfaces/modules/module-metadata.interface';
+import { ModuleMetadata } from '@nestjs/common';
 import type { ModuleRef, HttpAdapterHost } from '@nestjs/core';
 import type { Express } from 'express';
 import { WebSocketServer } from 'ws';
@@ -20,6 +20,16 @@ type FilteredParams<Path> = Path extends `${infer First}/${infer Second}`
     ? IsParam<First> | FilteredParams<Second>
     : IsParam<Path>
 
+/**
+ * @desc The type for the params in a request
+ * @typeParam Path - The path to get the params from
+ * @example
+ *
+ * const params: Params<'/api/:id'> = {
+ *    id: '123',
+ *    foo: 'bar', // Error: Type 'string' is not assignable to type 'undefined'
+ * }
+ */
 type Params<Path> = {
     [Key in FilteredParams<Path>]: string
 }
@@ -677,13 +687,13 @@ declare function GetEventPayload(): ParameterDecorator;
 
 /**
  * @desc The Decorator for retrieving the EventRequest Params object from the request in a handler
- * @returns {EventParams}
+ * @returns {Params}
  */
 declare function GetEventParams(): ParameterDecorator;
 
 /**
  * @desc The Decorator for retrieving the EventRequest Query object from the request in a handler
- * @returns {EventParams}
+ * @returns {Record<string, string>}
  */
 declare function GetEventQuery(): ParameterDecorator;
 
@@ -719,19 +729,19 @@ declare function GetConnectionRequestId(): ParameterDecorator;
 
 /**
  * @desc The Decorator for retrieving the ConnectionParams in a handler
- * @returns {EventParams}
+ * @returns {Params}
  */
 declare function GetConnectionParams(): ParameterDecorator;
 
 /**
  * @desc The Decorator for retrieving the ConnectionHeaders from the request in a handler
- * @returns {EventParams}
+ * @returns {IncomingHttpHeaders}
  */
 declare function GetConnectionHeaders(): ParameterDecorator;
 
 /**
  * @desc The Decorator for retrieving the ConnectionQuery in a handler
- * @returns {EventParams}
+ * @returns {Record<string, string>}
  */
 declare function GetConnectionQuery(): ParameterDecorator;