Merge branch 'master' of https://github.com/Rapsssito/react-native-tcp-socket into master

Author: Rapsssito

.github/workflows/stale.yml

@@ -12,5 +12,6 @@ jobs:
         repo-token: ${{ secrets.GITHUB_TOKEN }}
         stale-issue-message: 'Hey there, it looks like there has been no activity on this issue recently. Has the issue been fixed, or does it still require the community attention? This issue may be closed if no further activity occurs.'
         stale-issue-label: 'stale'
+        exempt-issue-labels: 'work-in-progress'
         days-before-stale: 30
         days-before-close: 5

CHANGELOG.md

@@ -1,3 +1,10 @@
+# [4.3.0](https://github.com/Rapsssito/react-native-tcp-socket/compare/v4.2.0...v4.3.0) (2020-08-12)
+
+
+### Features
+
+* Add socket.setEncoding() method ([#74](https://github.com/Rapsssito/react-native-tcp-socket/issues/74)) ([bfa80ea](https://github.com/Rapsssito/react-native-tcp-socket/commit/bfa80ea3b690f8a486882b4921397633957f4686))
+
 # [4.2.0](https://github.com/Rapsssito/react-native-tcp-socket/compare/v4.1.0...v4.2.0) (2020-07-06)
 
 

README.md

@@ -179,18 +179,24 @@ const client = TcpSocket.createConnection({
 _Note: In order to use self-signed certificates make sure to [update your metro.config.js configuration](#self-signed-ssl-only-available-for-react-native--060)._
 
 ## API
-Here are listed all methods implemented in `react-native-tcp-socket`, their functionalities are equivalent to those provided by Node's [net](https://nodejs.org/api/net.html) (more info on [#41](https://github.com/Rapsssito/react-native-tcp-socket/issues/41)). However, the **methods whose interface differs from Node are shown in bold**.
+Here are listed all methods implemented in `react-native-tcp-socket`, their functionalities are equivalent to those provided by Node's [net](https://nodejs.org/api/net.html) (more info on [#41](https://github.com/Rapsssito/react-native-tcp-socket/issues/41)). However, the **methods whose interface differs from Node are marked in bold**.
 
 ### TcpSocket
 * **Methods:**
   * **[`TcpSocket.createConnection(options[, callback])`](#createconnection)**
   * [`address()`](https://nodejs.org/api/net.html#net_socket_address)
   * [`destroy([error])`](https://nodejs.org/api/net.html#net_socket_destroy_error)
   * [`end([data][, encoding][, callback])`](https://nodejs.org/api/net.html#net_socket_end_data_encoding_callback)
+  * [`setEncoding([encoding])`](https://nodejs.org/api/net.html#net_socket_setencoding_encoding)
   * [`setKeepAlive([enable][, initialDelay])`](https://nodejs.org/api/net.html#net_socket_setkeepalive_enable_initialdelay) - _`initialDelay` is ignored_
   * [`setNoDelay([noDelay])`](https://nodejs.org/api/net.html#net_socket_setnodelay_nodelay)
   * [`setTimeout(timeout[, callback])`](https://nodejs.org/api/net.html#net_socket_settimeout_timeout_callback)
   * [`write(data[, encoding][, callback])`](https://nodejs.org/api/net.html#net_socket_write_data_encoding_callback)
+* **Events:**
+  * [`'close'`](https://nodejs.org/api/net.html#net_event_close_1)
+  * [`'connect'`](https://nodejs.org/api/net.html#net_event_connect)
+  * [`'data'`](https://nodejs.org/api/net.html#net_event_data)
+  * [`'error'`](https://nodejs.org/api/net.html#net_event_error_1)
 
 #### `createConnection()`
 `createConnection(options[, callback])` creates a TCP connection using the given [`options`](#createconnection-options).

coverage/coverage-final.json

@@ -42,6 +42,7 @@ export default class TcpServer extends TcpSocket {
         tlsCert?: any;
     }, callback?: ((address: string) => void) | undefined): TcpServer;
     setTimeout(timeout: number, callback?: (() => void) | undefined): TcpServer;
+    setEncoding(encoding?: "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "latin1" | "binary" | "hex" | undefined): TcpServer;
     setNoDelay(noDelay?: boolean): TcpServer;
     setKeepAlive(enable?: boolean, initialDelay?: number): TcpServer;
     addListener(event: string | symbol, listener: (...args: any[]) => void): TcpServer;

lib/types/TcpServer.d.ts

@@ -28,6 +28,7 @@ export default class TcpSocket extends EventEmitter {
     _timeout: NodeJS.Timeout | undefined;
     /** @type {number} */
     _state: number;
+    _encoding: "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "latin1" | "binary" | "hex" | undefined;
     /**
      * @protected
      */
@@ -80,6 +81,16 @@ export default class TcpSocket extends EventEmitter {
      * @private
      */
     private _clearTimeout;
+    /**
+     * Set the encoding for the socket as a Readable Stream. By default, no encoding is assigned and stream data will be returned as `Buffer` objects.
+     * Setting an encoding causes the stream data to be returned as strings of the specified encoding rather than as Buffer objects.
+     *
+     * For instance, calling `socket.setEncoding('utf8')` will cause the output data to be interpreted as UTF-8 data, and passed as strings.
+     * Calling `socket.setEncoding('hex')` will cause the data to be encoded in hexadecimal string format.
+     *
+     * @param {BufferEncoding} [encoding]
+     */
+    setEncoding(encoding?: "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "latin1" | "binary" | "hex" | undefined): TcpSocket;
     /**
      * Enable/disable the use of Nagle's algorithm. When a TCP connection is created, it will have Nagle's algorithm enabled.
      *

lib/types/TcpSocket.d.ts

@@ -1,7 +1,7 @@
 {
   "name": "react-native-tcp-socket",
   "title": "React Native Tcp Socket",
-  "version": "4.2.0",
+  "version": "4.3.0",
   "description": "React Native TCP socket API for Android & iOS with SSL/TLS support",
   "main": "src/index.js",
   "types": "lib/types/index.d.ts",

package.json

@@ -42,6 +42,7 @@ export default class TcpSocket extends EventEmitter {
         this._timeout = undefined;
         /** @type {number} */
         this._state = STATE.DISCONNECTED;
+        this._encoding = undefined;
         this._registerEvents();
         if (address != undefined) this._setConnected(address);
     }
@@ -54,7 +55,8 @@ export default class TcpSocket extends EventEmitter {
         this._dataListener = this._eventEmitter.addListener('data', (evt) => {
             if (evt.id !== this._id) return;
             const bufferTest = Buffer.from(evt.data, 'base64');
-            this.emit('data', bufferTest);
+            const finalData = this._encoding ? bufferTest.toString(this._encoding) : bufferTest;
+            this.emit('data', finalData);
         });
         this._errorListener = this._eventEmitter.addListener('error', (evt) => {
             if (evt.id !== this._id) return;
@@ -155,6 +157,20 @@ export default class TcpSocket extends EventEmitter {
         }
     }
 
+    /**
+     * Set the encoding for the socket as a Readable Stream. By default, no encoding is assigned and stream data will be returned as `Buffer` objects.
+     * Setting an encoding causes the stream data to be returned as strings of the specified encoding rather than as Buffer objects.
+     *
+     * For instance, calling `socket.setEncoding('utf8')` will cause the output data to be interpreted as UTF-8 data, and passed as strings.
+     * Calling `socket.setEncoding('hex')` will cause the data to be encoded in hexadecimal string format.
+     *
+     * @param {BufferEncoding} [encoding]
+     */
+    setEncoding(encoding) {
+        this._encoding = encoding;
+        return this;
+    }
+
     /**
      * Enable/disable the use of Nagle's algorithm. When a TCP connection is created, it will have Nagle's algorithm enabled.
      *