@apple-pie/slice 0.1.6 → 0.1.7

package/dist/types/utils/objects/WSConnection/WSConnection.d.ts

@@ -38,6 +38,9 @@ interface WSConnectionStandardOptions<TMessage = unknown> extends WSConnectionOp
     onMessageCallback?: WSStandardMessageCallback<TMessage>;
 }
 export type WSConnectionOptions<TMessage = unknown> = WSConnectionStandardOptions<TMessage> | WSConnectionUnifiedOptions<TMessage>;
+/**
+ * Manage a WebSocket connection with optional unified events, retries, and keep-alive pings.
+ */
 export declare class WSConnection<TMessage = unknown> {
     private readonly url;
     private readonly autoReconnect;
@@ -57,90 +60,99 @@ export declare class WSConnection<TMessage = unknown> {
     private reconnectIntervalTimer;
     private reconnectAttemptsCount;
     private manuallyClosed;
+    /**
+     * Report whether the underlying socket is currently open.
+     */
     get connected(): boolean;
+    /**
+     * Expose the underlying WebSocket instance.
+     */
     get connection(): WebSocket | null;
+    /**
+     * Initialize the socket connection and configure its runtime options.
+     */
     constructor(options: WSConnectionOptions<TMessage>);
     /**
-     * Gracefully handle sending messages
+     * Send a string or JSON-serializable payload through the socket.
      */
     send(message: unknown): void;
     /**
-     * Gracefully expose socket close
+     * Close the socket intentionally and stop any reconnect attempts.
      */
     close(closeEvent: {
         code: number;
         reason: string;
     }): void;
     /**
-     * Emit the parsed message content for standard mode
+     * Emit parsed message data when standard callback mode is enabled.
      */
     private emitParsedMessage;
     /**
-     * Emit a unified message if the unified flag is on
+     * Emit a unified event object when unified callback mode is enabled.
      */
     private emitUnifiedMessage;
     /**
-     * Emit error
+     * Forward an error event through both direct and unified callbacks.
      */
     private emitErrorEvent;
     /**
-     * Safe JSON parse message content
+     * Parse incoming message data, falling back to raw socket payloads when needed.
      */
     private parseEventData;
     /**
-     * Open handler
+     * Initialize connection state after the socket opens.
      */
     private readonly onOpen;
     /**
-     * Message handler
+     * Parse and emit each incoming socket message.
      */
     private readonly onMessage;
     /**
-     * Close handler with the reconnection logic as needed
+     * Clean up the socket and trigger reconnect logic after unexpected closes.
      */
     private readonly onClose;
     /**
-     * Error handler
+     * Normalize socket errors before forwarding them to consumers.
      */
     private readonly onError;
     /**
-     * Attach socket listeners
+     * Attach the connection lifecycle listeners to the current socket.
      */
     private attachEventListeners;
     /**
-     * set keep alive pings
+     * Start periodic ping messages to keep the socket active.
      */
     private setKeepAlive;
     /**
-     * Clear keep alive pings
+     * Stop the active keep-alive timer if one is running.
      */
     private clearKeepAliveTimer;
     /**
-     * Clear reconnect timer
+     * Stop the active reconnect timer if one is running.
      */
     private clearReconnectTimer;
     /**
-     * detach all event listeners
+     * Detach all lifecycle listeners from the current socket.
      */
     private detachEventListeners;
     /**
-     * Connect the socket
+     * Open a new socket connection when one is not already active.
      */
     private connect;
     /**
-     * Reconnect logic
+     * Schedule the next reconnect attempt when reconnects are allowed.
      */
     private reconnect;
     /**
-     * Calculate reconnect delay with fall off
+     * Calculate the reconnect delay, optionally using exponential backoff.
      */
     private getReconnectDelay;
     /**
-     * Determine if should reconnect based on the close event and props
+     * Decide whether a close event should trigger a reconnect attempt.
      */
     private shouldReconnect;
     /**
-     * Internal close socket - does not reset retry logic
+     * Close the current socket instance and release its timers and listeners.
      */
     private closeSocket;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@apple-pie/slice",
-	"version": "0.1.6",
+	"version": "0.1.7",
 	"main": "dist/cjs/index.js",
 	"module": "dist/esm/index.mjs",
 	"exports": {