Skip to content

Commit b55a260

Browse files
committed
fix: Update TypeScript declaration files
1 parent 5186d95 commit b55a260

File tree

7 files changed

+1451
-605
lines changed

7 files changed

+1451
-605
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ client.on('close', function(){
146146
```javascript
147147
const server = TcpSocket.createServer(function(socket) {
148148
socket.on('data', (data) => {
149-
socket.write('Echo server', data);
149+
socket.write('Echo server ' + data);
150150
});
151151

152152
socket.on('error', (error) => {

__tests__/index.test.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import { expect, test } from '@jest/globals';
12
import TcpSockets from '../src/index';
23
import TcpServer from '../src/TcpServer';
34
import TcpSocket from '../src/TcpSocket';

package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@
6161
"@semantic-release/git": "^9.0.0",
6262
"@semantic-release/github": "^7.0.0",
6363
"@semantic-release/npm": "^7.0.0",
64+
"@types/events": "^3.0.0",
6465
"@types/jest": "^25.1.3",
6566
"@types/react-native": "^0.61.17",
6667
"babel-eslint": "^10.1.0",
@@ -70,13 +71,13 @@
7071
"eslint-plugin-jest": "^23.6.0",
7172
"eslint-plugin-jsdoc": "^21.0.0",
7273
"eslint-plugin-prettier": "^3.1.1",
73-
"jest": "^24.9.0",
74+
"jest": "^26.6.3",
7475
"metro-react-native-babel-preset": "^0.58.0",
7576
"prettier": "^1.18.2",
7677
"react": "16.9.0",
7778
"react-native": "0.60.0",
7879
"semantic-release": "^17.0.1",
79-
"typescript": "^3.8.2"
80+
"typescript": "^4.1.3"
8081
},
8182
"dependencies": {
8283
"buffer": "^5.4.3",

src/TcpServer.js

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,13 @@ import { NativeModules } from 'react-native';
44
const Sockets = NativeModules.TcpSockets;
55
import TcpSocket from './TcpSocket';
66

7+
/**
8+
* @typedef {import('react-native').NativeEventEmitter} NativeEventEmitter
9+
*/
710
export default class TcpServer extends TcpSocket {
811
/**
912
* @param {number} id
10-
* @param {import("react-native").NativeEventEmitter} eventEmitter
13+
* @param {NativeEventEmitter} eventEmitter
1114
* @param {(socket: TcpSocket) => void} connectionCallback
1215
*/
1316
constructor(id, eventEmitter, connectionCallback) {

src/TcpSocket.js

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
import { NativeModules, Image } from 'react-native';
44
import { EventEmitter } from 'events';
5-
const Buffer = (global.Buffer = global.Buffer || require('buffer').Buffer);
5+
import { Buffer } from 'buffer';
66
const Sockets = NativeModules.TcpSockets;
77

88
const STATE = {
@@ -12,6 +12,10 @@ const STATE = {
1212
};
1313

1414
/**
15+
* @typedef {"ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "latin1" | "binary" | "hex"} BufferEncoding
16+
*
17+
* @typedef {import('react-native').NativeEventEmitter} NativeEventEmitter
18+
*
1519
* @typedef {{
1620
* port: number;
1721
* host?: string;
@@ -30,18 +34,22 @@ export default class TcpSocket extends EventEmitter {
3034
* Initialices a TcpSocket.
3135
*
3236
* @param {number} id
33-
* @param {import('react-native').NativeEventEmitter} eventEmitter
37+
* @param {NativeEventEmitter} eventEmitter
3438
* @param {string} [address]
3539
*/
3640
constructor(id, eventEmitter, address) {
3741
super();
42+
/** @protected */
3843
this._id = id;
44+
/** @protected */
3945
this._eventEmitter = eventEmitter;
40-
/** @type {number} */
46+
/** @type {number} @private */
4147
this._timeoutMsecs = 0;
48+
/** @private */
4249
this._timeout = undefined;
43-
/** @type {number} */
50+
/** @type {number} @private */
4451
this._state = STATE.DISCONNECTED;
52+
/** @private */
4553
this._encoding = undefined;
4654
this._registerEvents();
4755
if (address != undefined) this._setConnected(address);

tsconfig.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
"noEmit": true,
66
"strict": true,
77
"skipLibCheck": true,
8+
"typeRoots": ["@types/events"]
89
},
910
"include": ["src/", "__tests__/", "__mocks__/"],
1011
}

0 commit comments

Comments
 (0)