iosignal 4.0.0 → 4.6.0

package/.vscode/settings.json

@@ -1,3 +1,3 @@
 {
-    "liveServer.settings.port": 5502
+    "liveServer.settings.port": 5501
 }

package/README.md

@@ -1,5 +1,3 @@
-[ [English](./README.en.md) | 한국어 ]
-
 
 # IOSignal
 

package/dist/io.d.ts

@@ -162,7 +162,7 @@ declare class IOCore extends EventEmitter<string | symbol, any> {
     /**
      * Disables auto-reconnect and closes the current connection.
      * The instance can be re-opened manually later. For complete cleanup, use destroy().
-     */
+    */
     stop(): void;
     /**
      * Permanently destroys the instance, cleaning up all resources.
@@ -170,8 +170,9 @@ declare class IOCore extends EventEmitter<string | symbol, any> {
      */
     destroy(): void;
     /**
-     * The core keep-alive logic. It checks if auto-reconnect is enabled.
-     * The actual check for the socket's state is implemented in the child classes.
+     * The core keep-alive logic.
+     * The specific logic for checking the socket's state and reconnecting
+     * is implemented keepConnection() in the child classes (IOWS, IOCongSocket, etc.).
      */
     keepAlive(): void;
     /**
@@ -194,18 +195,18 @@ declare class IOCore extends EventEmitter<string | symbol, any> {
     onClose(): void;
     /**
      * Manually logs in with provided ID and key.
-     * @param {string} id - The user ID.
+     * @param {string} id - The user ID. or 'id.key'
      * @param {string} key - The user key.
-     * @returns {boolean}
+     * @returns {this}
      */
-    login(id: string, key: string): boolean;
+    login(id: string, key: string): this;
     /**
      * Sets up authentication for auto-login.
-     * @param {string} id - The user ID.
+     * @param {string} id - The user ID. or 'id.Key'
      * @param {string} key - The user key.
-     * @returns {boolean}
+     * @returns {this}
      */
-    auth(id: string, key: string): boolean;
+    auth(id: string, key: string): this;
     /**
      * Handles incoming data from the WebSocket.
      * @param {Buffer} buffer - The incoming data buffer.
@@ -264,10 +265,12 @@ declare class IOCore extends EventEmitter<string | symbol, any> {
      */
     testPromise(buffer: Buffer$1): void;
     /**
-     * Publishes a signal.
+     * alias of signal()
+     * Sends a signal with a tag and arguments.
+     * @param {string} tag - The signal tag.
      * @param {...any} args - Arguments for the signal.
      */
-    publish(...args: any[]): void;
+    publish(tag: string, ...args: any[]): void;
     /**
      * Sends a signal with a tag and arguments.
      * @param {string} tag - The signal tag.
@@ -459,6 +462,10 @@ declare class IO extends IOCore {
      * Pings the server when the browser tab becomes visible.
      */
     browserVisiblePing(): void;
+    /**
+     * Keeps the connection alive by re-connecting if closed.
+     */
+    keepConnection(): void;
     /**
      * Creates a new WebSocket connection.
      * @param {string} url - The WebSocket URL to connect to.