velocious 1.0.428 → 1.0.430

package/build/src/http-server/index.d.ts

@@ -1,5 +1,6 @@
 export default class VelociousHttpServer {
     /**
+     * Runs constructor.
      * @param {object} args - Options object.
      * @param {import("../configuration.js").default} args.configuration - Configuration instance.
      * @param {string} [args.host] - Host.
@@ -30,22 +31,36 @@ export default class VelociousHttpServer {
     });
     clientCount: number;
     _starting: boolean;
-    /** @type {DevelopmentReloader | DevelopmentReloaderLike | undefined} */
+    /**
+     * Narrows the runtime value to the documented type.
+      @type {DevelopmentReloader | DevelopmentReloaderLike | undefined} */
     developmentReloader: DevelopmentReloader | DevelopmentReloaderLike | undefined;
-    /** @type {import("net").Server | undefined} */
+    /**
+     * Narrows the runtime value to the documented type.
+      @type {import("net").Server | undefined} */
     netServer: import("net").Server | undefined;
-    /** @type {WorkerHandlerFactory | undefined} */
+    /**
+     * Narrows the runtime value to the documented type.
+      @type {WorkerHandlerFactory | undefined} */
     workerHandlerFactory: WorkerHandlerFactory | undefined;
-    /** @type {Record<string, ServerClient>}  */
+    /**
+     * Clients.
+      @type {Record<string, ServerClient>}  */
     clients: Record<string, ServerClient>;
-    /** @type {Set<import("net").Socket>} */
+    /**
+     * Active sockets.
+      @type {Set<import("net").Socket>} */
     _activeSockets: Set<import("net").Socket>;
     events: import("eventemitter3").EventEmitter<string | symbol, any>;
     workerCount: number;
-    /** @type {Array<WorkerHandler | InProcessHandler>} */
+    /**
+     * Worker handlers.
+      @type {Array<WorkerHandler | InProcessHandler>} */
     workerHandlers: Array<WorkerHandler | InProcessHandler>;
     nextWorkerHandlerIndex: number;
-    /** @type {Map<string, WorkerHandler | InProcessHandler>} */
+    /**
+     * Sticky worker handlers.
+      @type {Map<string, WorkerHandler | InProcessHandler>} */
     stickyWorkerHandlers: Map<string, WorkerHandler | InProcessHandler>;
     configuration: import("../configuration.js").default;
     developmentReloaderFactory: ((arg0: {
@@ -62,71 +77,115 @@ export default class VelociousHttpServer {
     host: string;
     port: number;
     workers: number;
-    /** @returns {Promise<void>} - Resolves when complete.  */
+    /**
+     * Runs start.
+     * @returns {Promise<void>} - Resolves when complete.
+     */
     start(): Promise<void>;
-    /** @returns {{developmentReloader: DevelopmentReloader | DevelopmentReloaderLike | undefined, netServer: import("net").Server | undefined, workerHandlers: Array<WorkerHandler | InProcessHandler>}} - Startup state. */
+    /**
+     * Runs capture startup state.
+     * @returns {{developmentReloader: DevelopmentReloader | DevelopmentReloaderLike | undefined, netServer: import("net").Server | undefined, workerHandlers: Array<WorkerHandler | InProcessHandler>}} - Startup state.
+     */
     _captureStartupState(): {
         developmentReloader: DevelopmentReloader | DevelopmentReloaderLike | undefined;
         netServer: import("net").Server | undefined;
         workerHandlers: Array<WorkerHandler | InProcessHandler>;
     };
     /**
+     * Runs stop startup resources.
      * @param {ReturnType<VelociousHttpServer["_captureStartupState"]>} startupState - State captured before startup.
      * @returns {Promise<void>} - Resolves when cleanup is complete.
      */
     _stopStartupResources(startupState: ReturnType<VelociousHttpServer["_captureStartupState"]>): Promise<void>;
-    /** @returns {Promise<void>} - Resolves when complete.  */
+    /**
+     * Runs net server listen.
+     * @returns {Promise<void>} - Resolves when complete.
+     */
     _netServerListen(): Promise<void>;
-    /** @returns {Promise<void>} - Resolves when complete.  */
+    /**
+     * Runs ensure workers.
+     * @returns {Promise<void>} - Resolves when complete.
+     */
     _ensureWorkers(): Promise<void>;
-    /** @returns {boolean} - Whether active.  */
+    /**
+     * Runs is active.
+     * @returns {boolean} - Whether active.
+     */
     isActive(): boolean;
-    /** @returns {Promise<Record<string, unknown>>} - HTTP server worker diagnostics. */
+    /**
+     * Runs get debug snapshot.
+     * @returns {Promise<Record<string, ?>>} - HTTP server worker diagnostics.
+     */
     getDebugSnapshot(): Promise<Record<string, unknown>>;
     /**
+     * Runs worker debug snapshot.
      * @param {WorkerHandler | InProcessHandler} workerHandler - Worker handler to inspect.
-     * @returns {Promise<Record<string, unknown>>} Worker debug snapshot.
+     * @returns {Promise<Record<string, ?>>} Worker debug snapshot.
      */
     workerDebugSnapshot(workerHandler: WorkerHandler | InProcessHandler): Promise<Record<string, unknown>>;
     /**
+     * Runs in process worker debug snapshot.
      * @param {InProcessHandler} workerHandler - In-process worker handler to inspect.
-     * @returns {Record<string, unknown>} Worker debug snapshot.
+     * @returns {Record<string, ?>} Worker debug snapshot.
      */
     inProcessWorkerDebugSnapshot(workerHandler: InProcessHandler): Record<string, unknown>;
-    /** @returns {Promise<void>} - Resolves when complete.  */
+    /**
+     * Runs stop clients.
+     * @returns {Promise<void>} - Resolves when complete.
+     */
     stopClients(): Promise<void>;
     /**
+     * Runs stop server.
      * @param {import("net").Server | undefined} [netServer] - Server to stop.
      * @returns {Promise<void>} - Resolves when complete.
      */
     stopServer(netServer?: import("net").Server | undefined): Promise<void>;
-    /** @returns {Promise<void>} - Resolves when complete.  */
+    /**
+     * Runs stop.
+     * @returns {Promise<void>} - Resolves when complete.
+     */
     stop(): Promise<void>;
     _stopping: boolean | undefined;
-    /** @returns {void} - No return value.  */
+    /**
+     * On close.
+     * @returns {void} - No return value.
+     */
     onClose: () => void;
     /**
+     * On server error.
      * @param {Error} error - Server socket error.
      * @returns {void} - No return value.
      */
     onServerError: (error: Error) => void;
     /**
+     * On connection.
      * @param {import("net").Socket} socket - Socket instance.
      * @returns {void} - No return value.
      */
     onConnection: (socket: import("net").Socket) => void;
     /**
+     * On client close.
      * @param {ServerClient} client - Client instance.
      * @returns {void} - No return value.
      */
     onClientClose: (client: ServerClient) => void;
-    /** @returns {Promise<void>} - Resolves when complete.  */
+    /**
+     * Runs spawn worker.
+     * @returns {Promise<void>} - Resolves when complete.
+     */
     spawnWorker(): Promise<void>;
-    /** @returns {Promise<Array<WorkerHandler | InProcessHandler>>} - Started worker handlers. */
+    /**
+     * Runs build worker handlers.
+     * @returns {Promise<Array<WorkerHandler | InProcessHandler>>} - Started worker handlers.
+     */
     _buildWorkerHandlers(): Promise<Array<WorkerHandler | InProcessHandler>>;
-    /** @returns {Promise<WorkerHandler | InProcessHandler>} - Started worker handler. */
+    /**
+     * Runs build worker handler.
+     * @returns {Promise<WorkerHandler | InProcessHandler>} - Started worker handler.
+     */
     _buildWorkerHandler(): Promise<WorkerHandler | InProcessHandler>;
     /**
+     * Runs worker handler to use.
      * @param {object} [args] - Options object.
      * @param {string} [args.stickyKey] - Stable key that must keep routing to the same worker.
      * @returns {WorkerHandler | InProcessHandler} - The worker handler to use.
@@ -134,21 +193,39 @@ export default class VelociousHttpServer {
     workerHandlerToUse({ stickyKey }?: {
         stickyKey?: string | undefined;
     }): WorkerHandler | InProcessHandler;
-    /** @returns {WorkerHandler | InProcessHandler} - The next round-robin worker handler. */
+    /**
+     * Runs next round robin worker handler.
+     * @returns {WorkerHandler | InProcessHandler} - The next round-robin worker handler.
+     */
     _nextRoundRobinWorkerHandler(): WorkerHandler | InProcessHandler;
-    /** @returns {boolean} - Whether development worker hot reload should run. */
+    /**
+     * Runs should use development hot reload.
+     * @returns {boolean} - Whether development worker hot reload should run.
+     */
     shouldUseDevelopmentHotReload(): boolean;
-    /** @returns {Promise<void>} - Resolves when watcher setup finishes. */
+    /**
+     * Runs start development reloader.
+     * @returns {Promise<void>} - Resolves when watcher setup finishes.
+     */
     _startDevelopmentReloader(): Promise<void>;
-    /** @returns {Promise<void>} - Resolves when workers have been refreshed. */
+    /**
+     * Runs reload workers for development.
+     * @returns {Promise<void>} - Resolves when workers have been refreshed.
+     */
     reloadWorkersForDevelopment(): Promise<void>;
     _reloadWorkersForDevelopmentQueued: boolean | undefined;
     _reloadingWorkersForDevelopment: boolean | undefined;
 }
+/**
+ * Defines this typedef.
+ */
 export type DevelopmentReloaderLike = {
     start: () => Promise<void>;
     stop: () => Promise<void>;
 };
+/**
+ * Defines this typedef.
+ */
 export type WorkerHandlerFactory = (arg0: {
     configuration: import("../configuration.js").default;
     workerCount: number;

package/build/src/http-server/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/http-server/index.js"],"names":[],"mappings":"AA8BA;IA4BE;;;;;;;;;;OAUG;IACH,6HATG;QAAoD,aAAa,EAAzD,OAAO,qBAAqB,EAAE,OAAO;QACvB,IAAI;QACH,SAAS;QACV,IAAI;QACJ,UAAU;QACV,OAAO;QACwK,0BAA0B,WAA9M;YAAC,aAAa,EAAE,OAAO,qBAAqB,EAAE,OAAO,CAAC;YAAC,QAAQ,EAAE,CAAS,IAAqB,EAArB;gBAAC,WAAW,EAAE,MAAM,CAAA;aAAC,KAAI,OAAO,CAAC,IAAI,CAAC,CAAA;SAAC,KAAI;YAAC,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;YAAC,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;SAAC;QACzJ,oBAAoB;KAC1D,EAUA;IA/CD,oBAAe;IACf,mBAAiB;IAEjB,wEAAwE;IACxE,qBADW,mBAAmB,GAAG,uBAAuB,GAAG,SAAS,CACjD;IAEnB,+CAA+C;IAC/C,WADW,OAAO,KAAK,EAAE,MAAM,GAAG,SAAS,CAClC;IAET,+CAA+C;IAC/C,sBADW,oBAAoB,GAAG,SAAS,CACvB;IAEpB,4CAA4C;IAC5C,SADW,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAC3B;IAEZ,wCAAwC;IACxC,gBADW,GAAG,CAAC,OAAO,KAAK,EAAE,MAAM,CAAC,CACV;IAE1B,mEAA2B;IAC3B,oBAAe;IAEf,sDAAsD;IACtD,gBADW,KAAK,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAC/B;IACnB,+BAA0B;IAC1B,4DAA4D;IAC5D,sBADW,GAAG,CAAC,MAAM,EAAE,aAAa,GAAG,gBAAgB,CAAC,CACxB;IAc9B,qDAAkC;IAClC,oCALkB;QAAC,aAAa,EAAE,OAAO,qBAAqB,EAAE,OAAO,CAAC;QAAC,QAAQ,EAAE,CAAS,IAAqB,EAArB;YAAC,WAAW,EAAE,MAAM,CAAA;SAAC,KAAI,OAAO,CAAC,IAAI,CAAC,CAAA;KAAC,KAAI;QAAC,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;QAAC,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;KAAC,cAKlI;IAE5D,mBAAmC;IACnC,eAA8B;IAC9B,aAA6B;IAC7B,aAAwB;IACxB,gBAA0D;IAG5D,0DAA0D;IAC1D,SADc,OAAO,CAAC,IAAI,CAAC,CAwB1B;IAED,yNAAyN;IACzN,wBADc;QAAC,mBAAmB,EAAE,mBAAmB,GAAG,uBAAuB,GAAG,SAAS,CAAC;QAAC,SAAS,EAAE,OAAO,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,cAAc,EAAE,KAAK,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAAA;KAAC,CAOnM;IAED;;;OAGG;IACH,oCAHW,UAAU,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,CAAC,GACrD,OAAO,CAAC,IAAI,CAAC,CAsBzB;IAED,0DAA0D;IAC1D,oBADc,OAAO,CAAC,IAAI,CAAC,CAsB1B;IAED,0DAA0D;IAC1D,kBADc,OAAO,CAAC,IAAI,CAAC,CAK1B;IAED,4CAA4C;IAC5C,YADc,OAAO,CAOpB;IAED,oFAAoF;IACpF,oBADc,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAW7C;IAED;;;OAGG;IACH,mCAHW,aAAa,GAAG,gBAAgB,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAO5C;IAED;;;OAGG;IACH,4CAHW,gBAAgB,GACd,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CASnC;IAED,0DAA0D;IAC1D,eADc,OAAO,CAAC,IAAI,CAAC,CAW1B;IAED;;;OAGG;IACH,uBAHW,OAAO,KAAK,EAAE,MAAM,GAAG,SAAS,GAC9B,OAAO,CAAC,IAAI,CAAC,CA4BzB;IAED,0DAA0D;IAC1D,QADc,OAAO,CAAC,IAAI,CAAC,CAY1B;IAVC,+BAAqB;IAYvB,0CAA0C;IAC1C,eADc,IAAI,CAGjB;IAED;;;OAGG;IACH,gBAAiB,OAHN,KAGW,KAFT,IAAI,CAIhB;IAED;;;OAGG;IACH,eAAgB,QAHL,OAAO,KAAK,EAAE,MAGH,KAFT,IAAI,CAmChB;IAED;;;OAGG;IACH,gBAAiB,QAHN,YAGY,KAFV,IAAI,CAahB;IAED,0DAA0D;IAC1D,eADc,OAAO,CAAC,IAAI,CAAC,CAK1B;IAED,6FAA6F;IAC7F,wBADc,OAAO,CAAC,KAAK,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAAC,CAU7D;IAED,qFAAqF;IACrF,uBADc,OAAO,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAiBtD;IAED;;;;OAIG;IACH,mCAHG;QAAsB,SAAS;KAC/B,GAAU,aAAa,GAAG,gBAAgB,CAkB5C;IAED,yFAAyF;IACzF,gCADc,aAAa,GAAG,gBAAgB,CAc7C;IAED,6EAA6E;IAC7E,iCADc,OAAO,CAGpB;IAED,uEAAuE;IACvE,6BADc,OAAO,CAAC,IAAI,CAAC,CAiB1B;IAED,4EAA4E;IAC5E,+BADc,OAAO,CAAC,IAAI,CAAC,CA2B1B;IAtBG,wDAA8C;IAIhD,qDAA2C;CAmB9C;sCAhda;IAAC,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAAC,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAAC;mCACvD,CAAS,IAA2E,EAA3E;IAAC,aAAa,EAAE,OAAO,qBAAqB,EAAE,OAAO,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAC,KAAI,CAAC,aAAa,GAAG,gBAAgB,CAAC;gCATxG,2BAA2B;yBAKlC,oBAAoB;0BACnB,2BAA2B;6BAJxB,gCAAgC;mBAC1C,cAAc"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/http-server/index.js"],"names":[],"mappings":"AAmCA;IA0CE;;;;;;;;;;;OAWG;IACH,6HATG;QAAoD,aAAa,EAAzD,OAAO,qBAAqB,EAAE,OAAO;QACvB,IAAI;QACH,SAAS;QACV,IAAI;QACJ,UAAU;QACV,OAAO;QACwK,0BAA0B,WAA9M;YAAC,aAAa,EAAE,OAAO,qBAAqB,EAAE,OAAO,CAAC;YAAC,QAAQ,EAAE,CAAS,IAAqB,EAArB;gBAAC,WAAW,EAAE,MAAM,CAAA;aAAC,KAAI,OAAO,CAAC,IAAI,CAAC,CAAA;SAAC,KAAI;YAAC,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;YAAC,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;SAAC;QACzJ,oBAAoB;KAC1D,EAUA;IA9DD,oBAAe;IACf,mBAAiB;IAEjB;;0EAEsE;IACtE,qBADS,mBAAmB,GAAG,uBAAuB,GAAG,SAAS,CAC/C;IAEnB;;iDAE6C;IAC7C,WADS,OAAO,KAAK,EAAE,MAAM,GAAG,SAAS,CAChC;IAET;;iDAE6C;IAC7C,sBADS,oBAAoB,GAAG,SAAS,CACrB;IAEpB;;8CAE0C;IAC1C,SADS,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CACzB;IAEZ;;0CAEsC;IACtC,gBADS,GAAG,CAAC,OAAO,KAAK,EAAE,MAAM,CAAC,CACR;IAE1B,mEAA2B;IAC3B,oBAAe;IAEf;;wDAEoD;IACpD,gBADS,KAAK,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAC7B;IACnB,+BAA0B;IAC1B;;8DAE0D;IAC1D,sBADS,GAAG,CAAC,MAAM,EAAE,aAAa,GAAG,gBAAgB,CAAC,CACtB;IAe9B,qDAAkC;IAClC,oCALkB;QAAC,aAAa,EAAE,OAAO,qBAAqB,EAAE,OAAO,CAAC;QAAC,QAAQ,EAAE,CAAS,IAAqB,EAArB;YAAC,WAAW,EAAE,MAAM,CAAA;SAAC,KAAI,OAAO,CAAC,IAAI,CAAC,CAAA;KAAC,KAAI;QAAC,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;QAAC,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;KAAC,cAKlI;IAE5D,mBAAmC;IACnC,eAA8B;IAC9B,aAA6B;IAC7B,aAAwB;IACxB,gBAA0D;IAG5D;;;OAGG;IACH,SAFa,OAAO,CAAC,IAAI,CAAC,CA2BzB;IAED;;;OAGG;IACH,wBAFa;QAAC,mBAAmB,EAAE,mBAAmB,GAAG,uBAAuB,GAAG,SAAS,CAAC;QAAC,SAAS,EAAE,OAAO,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,cAAc,EAAE,KAAK,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAAA;KAAC,CAQlM;IAED;;;;OAIG;IACH,oCAHW,UAAU,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,CAAC,GACrD,OAAO,CAAC,IAAI,CAAC,CAwBzB;IAED;;;OAGG;IACH,oBAFa,OAAO,CAAC,IAAI,CAAC,CA0BzB;IAED;;;OAGG;IACH,kBAFa,OAAO,CAAC,IAAI,CAAC,CAMzB;IAED;;;OAGG;IACH,YAFa,OAAO,CAQnB;IAED;;;OAGG;IACH,oBAFa,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAC,CAAC,CAAC,CAYtC;IAED;;;;OAIG;IACH,mCAHW,aAAa,GAAG,gBAAgB,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAC,CAAC,CAAC,CAOtC;IAED;;;;OAIG;IACH,4CAHW,gBAAgB,GACd,MAAM,CAAC,MAAM,EAAE,OAAC,CAAC,CAS7B;IAED;;;OAGG;IACH,eAFa,OAAO,CAAC,IAAI,CAAC,CAYzB;IAED;;;;OAIG;IACH,uBAHW,OAAO,KAAK,EAAE,MAAM,GAAG,SAAS,GAC9B,OAAO,CAAC,IAAI,CAAC,CA4BzB;IAED;;;OAGG;IACH,QAFa,OAAO,CAAC,IAAI,CAAC,CAazB;IAVC,+BAAqB;IAYvB;;;OAGG;IACH,eAFa,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAAiB,OAHN,KAGW,KAFT,IAAI,CAIhB;IAED;;;;OAIG;IACH,eAAgB,QAHL,OAAO,KAAK,EAAE,MAGH,KAFT,IAAI,CAmChB;IAED;;;;OAIG;IACH,gBAAiB,QAHN,YAGY,KAFV,IAAI,CAahB;IAED;;;OAGG;IACH,eAFa,OAAO,CAAC,IAAI,CAAC,CAMzB;IAED;;;OAGG;IACH,wBAFa,OAAO,CAAC,KAAK,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAAC,CAa5D;IAED;;;OAGG;IACH,uBAFa,OAAO,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAkBrD;IAED;;;;;OAKG;IACH,mCAHG;QAAsB,SAAS;KAC/B,GAAU,aAAa,GAAG,gBAAgB,CAkB5C;IAED;;;OAGG;IACH,gCAFa,aAAa,GAAG,gBAAgB,CAe5C;IAED;;;OAGG;IACH,iCAFa,OAAO,CAInB;IAED;;;OAGG;IACH,6BAFa,OAAO,CAAC,IAAI,CAAC,CAkBzB;IAED;;;OAGG;IACH,+BAFa,OAAO,CAAC,IAAI,CAAC,CA4BzB;IAtBG,wDAA8C;IAIhD,qDAA2C;CAmB9C;;;;sCAniBW;IAAC,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAAC,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAAC;;;;mCAGvD,CAAS,IAA2E,EAA3E;IAAC,aAAa,EAAE,OAAO,qBAAqB,EAAE,OAAO,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAC,KAAI,CAAC,aAAa,GAAG,gBAAgB,CAAC;gCAbtG,2BAA2B;yBAKlC,oBAAoB;0BACnB,2BAA2B;6BAJxB,gCAAgC;mBAC1C,cAAc"}