feat(connection): allow sending "Buffer" in "writeText" method

Author: fenying

CHANGES.md

@@ -3,6 +3,7 @@
 ## v0.2.4
 
 - feat(connection): added option `forceNewConnection` for connection creation.
+- feat(connection): allow sending `Buffer` in `writeText` method.
 
 ## v0.2.3
 

src/examples/http/client.ts

@@ -38,6 +38,7 @@ function writeLog(msg: string): void {
 
         cli.setMasking(false);
         cli.writeText('hello world');
+        cli.writeText(Buffer.from('hello world (buffer)'));
         cli.on('message', (msg) => {
 
             if (msg.mode !== $WS.EFrameReceiveMode.STANDARD) {

src/lib/AbstractConnection.ts

@@ -162,7 +162,7 @@ export abstract class AbstractWsConnection extends $Events.EventEmitter implemen
     }
 
     public writeText(
-        data: string | string[],
+        data: Buffer | string | Array<Buffer | string>,
         cb: D.IErrorCallback = this._defaultWriteCallback,
     ): boolean {
 

src/lib/Decl.ts

@@ -474,9 +474,12 @@ export interface IWebSocket {
     /**
      * Send a text message to remote-side, in a single TEXT message.
      *
-     * > Return true if the data is flushed to kernel buffer completely, otherwise false.
+     * @throws `E_CONN_LOST` will be thrown if the connection is closed.
+     * @throws `E_CONN_READONLY` will be thrown if the connection is not writable (half-closed).
+     *
+     * @returns true if the data is flushed to kernel buffer completely, otherwise false.
      */
-    writeText(data: string | string[], callback?: IErrorCallback): boolean;
+    writeText(data: Buffer | string | Array<Buffer | string>, callback?: IErrorCallback): boolean;
 
     /**
      * Send a binary message to remote-side, in a single BINARY message.