@forklaunch/hyper-express 0.4.5 → 0.4.7

package/lib/index.d.mts

@@ -9,23 +9,71 @@ export { ParsedQs } from 'qs';
 
 /**
  * Represents an application built on top of Hyper-Express and Forklaunch.
+ * This class provides a high-performance web server implementation using uWebSockets.js
+ * with Forklaunch's schema validation and API documentation capabilities.
  *
- * @template SV - A type that extends AnySchemaValidator.
+ * @template SV - Schema validator type extending AnySchemaValidator
+ *
+ * @example
+ * ```typescript
+ * const app = new Application(schemaValidator, openTelemetryCollector);
+ *
+ * app.get('/users', {
+ *   responses: {
+ *     200: { type: 'array', items: { type: 'object' } }
+ *   }
+ * }, async (req, res) => {
+ *   res.json(await getUsers());
+ * });
+ *
+ * await app.listen(3000);
+ * ```
  */
 declare class Application<SV extends AnySchemaValidator> extends ForklaunchExpressLikeApplication<SV, Server, MiddlewareHandler, Request<Record<string, unknown>>, Response<Record<string, unknown>>, MiddlewareNext> {
     private readonly docsConfiguration?;
     /**
      * Creates an instance of the Application class.
      *
-     * @param {SV} schemaValidator - The schema validator.
+     * @param {SV} schemaValidator - Schema validator for request/response validation
+     * @param {OpenTelemetryCollector<MetricsDefinition>} openTelemetryCollector - Collector for OpenTelemetry metrics
+     * @param {DocsConfiguration} [docsConfiguration] - Optional configuration for API documentation (Swagger/Scalar)
+     *
+     * @example
+     * ```typescript
+     * const app = new Application(
+     *   new SchemaValidator(),
+     *   new OpenTelemetryCollector(),
+     *   { type: 'swagger' }
+     * );
+     * ```
      */
     constructor(schemaValidator: SV, openTelemetryCollector: OpenTelemetryCollector<MetricsDefinition>, docsConfiguration?: DocsConfiguration | undefined);
     /**
-     * Starts the server and sets up Swagger documentation.
+     * Starts the server and sets up API documentation.
+     * Supports multiple listening configurations including port, host, and UNIX socket path.
+     * Automatically sets up Swagger or Scalar documentation based on configuration.
+     *
+     * @param {number | string} arg0 - Port number or UNIX socket path
+     * @param {string | Function} [arg1] - Host name or callback function
+     * @param {Function} [arg2] - Callback function when host is specified
+     * @returns {Promise<uWebsockets.us_listen_socket>} Promise resolving to the listening socket
+     *
+     * @example
+     * ```typescript
+     * // Listen on port 3000
+     * await app.listen(3000);
+     *
+     * // Listen on specific host and port
+     * await app.listen(3000, 'localhost');
+     *
+     * // Listen on UNIX socket
+     * await app.listen('/tmp/app.sock');
      *
-     * @param {string | number} arg0 - The port number or UNIX path to listen on.
-     * @param {...unknown[]} args - Additional arguments.
-     * @returns {Promise<uWebsockets.us_listen_socket>} - A promise that resolves with the listening socket.
+     * // With callback
+     * await app.listen(3000, (socket) => {
+     *   console.log('Server started');
+     * });
+     * ```
      */
     listen(port: number, callback?: (listen_socket: uWebsockets.us_listen_socket) => void): Promise<uWebsockets.us_listen_socket>;
     listen(port: number, host?: string, callback?: (listen_socket: uWebsockets.us_listen_socket) => void): Promise<uWebsockets.us_listen_socket>;

package/lib/index.d.ts

@@ -9,23 +9,71 @@ export { ParsedQs } from 'qs';
 
 /**
  * Represents an application built on top of Hyper-Express and Forklaunch.
+ * This class provides a high-performance web server implementation using uWebSockets.js
+ * with Forklaunch's schema validation and API documentation capabilities.
  *
- * @template SV - A type that extends AnySchemaValidator.
+ * @template SV - Schema validator type extending AnySchemaValidator
+ *
+ * @example
+ * ```typescript
+ * const app = new Application(schemaValidator, openTelemetryCollector);
+ *
+ * app.get('/users', {
+ *   responses: {
+ *     200: { type: 'array', items: { type: 'object' } }
+ *   }
+ * }, async (req, res) => {
+ *   res.json(await getUsers());
+ * });
+ *
+ * await app.listen(3000);
+ * ```
  */
 declare class Application<SV extends AnySchemaValidator> extends ForklaunchExpressLikeApplication<SV, Server, MiddlewareHandler, Request<Record<string, unknown>>, Response<Record<string, unknown>>, MiddlewareNext> {
     private readonly docsConfiguration?;
     /**
      * Creates an instance of the Application class.
      *
-     * @param {SV} schemaValidator - The schema validator.
+     * @param {SV} schemaValidator - Schema validator for request/response validation
+     * @param {OpenTelemetryCollector<MetricsDefinition>} openTelemetryCollector - Collector for OpenTelemetry metrics
+     * @param {DocsConfiguration} [docsConfiguration] - Optional configuration for API documentation (Swagger/Scalar)
+     *
+     * @example
+     * ```typescript
+     * const app = new Application(
+     *   new SchemaValidator(),
+     *   new OpenTelemetryCollector(),
+     *   { type: 'swagger' }
+     * );
+     * ```
      */
     constructor(schemaValidator: SV, openTelemetryCollector: OpenTelemetryCollector<MetricsDefinition>, docsConfiguration?: DocsConfiguration | undefined);
     /**
-     * Starts the server and sets up Swagger documentation.
+     * Starts the server and sets up API documentation.
+     * Supports multiple listening configurations including port, host, and UNIX socket path.
+     * Automatically sets up Swagger or Scalar documentation based on configuration.
+     *
+     * @param {number | string} arg0 - Port number or UNIX socket path
+     * @param {string | Function} [arg1] - Host name or callback function
+     * @param {Function} [arg2] - Callback function when host is specified
+     * @returns {Promise<uWebsockets.us_listen_socket>} Promise resolving to the listening socket
+     *
+     * @example
+     * ```typescript
+     * // Listen on port 3000
+     * await app.listen(3000);
+     *
+     * // Listen on specific host and port
+     * await app.listen(3000, 'localhost');
+     *
+     * // Listen on UNIX socket
+     * await app.listen('/tmp/app.sock');
      *
-     * @param {string | number} arg0 - The port number or UNIX path to listen on.
-     * @param {...unknown[]} args - Additional arguments.
-     * @returns {Promise<uWebsockets.us_listen_socket>} - A promise that resolves with the listening socket.
+     * // With callback
+     * await app.listen(3000, (socket) => {
+     *   console.log('Server started');
+     * });
+     * ```
      */
     listen(port: number, callback?: (listen_socket: uWebsockets.us_listen_socket) => void): Promise<uWebsockets.us_listen_socket>;
     listen(port: number, host?: string, callback?: (listen_socket: uWebsockets.us_listen_socket) => void): Promise<uWebsockets.us_listen_socket>;

package/lib/index.js

@@ -164,7 +164,18 @@ var Application = class extends import_http11.ForklaunchExpressLikeApplication {
   /**
    * Creates an instance of the Application class.
    *
-   * @param {SV} schemaValidator - The schema validator.
+   * @param {SV} schemaValidator - Schema validator for request/response validation
+   * @param {OpenTelemetryCollector<MetricsDefinition>} openTelemetryCollector - Collector for OpenTelemetry metrics
+   * @param {DocsConfiguration} [docsConfiguration] - Optional configuration for API documentation (Swagger/Scalar)
+   *
+   * @example
+   * ```typescript
+   * const app = new Application(
+   *   new SchemaValidator(),
+   *   new OpenTelemetryCollector(),
+   *   { type: 'swagger' }
+   * );
+   * ```
    */
   constructor(schemaValidator, openTelemetryCollector, docsConfiguration) {
     super(schemaValidator, new import_hyper_express_fork.Server(), openTelemetryCollector);

package/lib/index.mjs

@@ -154,7 +154,18 @@ var Application = class extends ForklaunchExpressLikeApplication {
   /**
    * Creates an instance of the Application class.
    *
-   * @param {SV} schemaValidator - The schema validator.
+   * @param {SV} schemaValidator - Schema validator for request/response validation
+   * @param {OpenTelemetryCollector<MetricsDefinition>} openTelemetryCollector - Collector for OpenTelemetry metrics
+   * @param {DocsConfiguration} [docsConfiguration] - Optional configuration for API documentation (Swagger/Scalar)
+   *
+   * @example
+   * ```typescript
+   * const app = new Application(
+   *   new SchemaValidator(),
+   *   new OpenTelemetryCollector(),
+   *   { type: 'swagger' }
+   * );
+   * ```
    */
   constructor(schemaValidator, openTelemetryCollector, docsConfiguration) {
     super(schemaValidator, new Server(), openTelemetryCollector);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forklaunch/hyper-express",
-  "version": "0.4.5",
+  "version": "0.4.7",
   "description": "Forklaunch framework for hyper-express.",
   "homepage": "https://github.com/forklaunch/forklaunch-js#readme",
   "bugs": {
@@ -34,9 +34,9 @@
     "swagger-ui-dist": "^5.20.7",
     "swagger-ui-express": "^5.0.1",
     "uWebSockets.js": "github:uNetworking/uWebSockets.js#v20.44.0",
-    "@forklaunch/common": "0.2.6",
-    "@forklaunch/validator": "0.4.12",
-    "@forklaunch/core": "0.6.5"
+    "@forklaunch/common": "0.2.7",
+    "@forklaunch/validator": "0.5.0",
+    "@forklaunch/core": "0.7.0"
   },
   "devDependencies": {
     "@eslint/js": "^9.24.0",