Skip to content

Commit f686cd6

Browse files
[fix] labeling of class members to private and protected as required
1 parent fdbe3c7 commit f686cd6

File tree

5 files changed

+59
-84
lines changed

5 files changed

+59
-84
lines changed

lib/client.d.ts

+39-59
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
11
/// <reference types="node" />
2-
/// <reference types="node" />
3-
/// <reference types="node" />
42
import EventEmitter from "events";
53
import { Validator } from "./validator";
6-
import Queue from "./queue";
74
import WebSocket from "ws";
8-
import { ExponentialStrategy } from "backoff";
95
import EventBuffer from "./event-buffer";
106
export interface RPC_ClientOptions {
117
identity: string;
@@ -41,43 +37,32 @@ export interface IHandlersOption {
4137
}
4238
type IHandlers = ({ params, reply, method, signal, messageId, }: IHandlersOption) => Promise<Record<string, any>>;
4339
declare class RPC_Client extends EventEmitter {
44-
_identity?: string;
45-
_wildcardHandler: IHandlers | null;
46-
_handlers: Map<string, IHandlers>;
47-
_state: number;
48-
_callQueue: Queue;
49-
_ws?: WebSocket;
50-
_wsAbortController?: AbortController;
51-
_keepAliveAbortController?: AbortController;
52-
_pendingPingResponse: boolean;
53-
_lastPingTime: number;
54-
_closePromise?: Promise<{
55-
code: number;
56-
reason: string;
57-
}>;
58-
_protocolOptions: string[];
59-
_protocol?: string;
60-
_strictProtocols: string[];
61-
_strictValidators?: Map<string, Validator>;
62-
_pendingCalls: Map<string, Record<string, any>>;
63-
_pendingResponses: Map<string, {
64-
abort: {
65-
(reason?: any): void;
66-
(reason?: any): void;
67-
};
68-
promise: Promise<any>;
69-
}>;
70-
_outboundMsgBuffer: string[];
71-
_connectedOnce: boolean;
72-
_backoffStrategy?: ExponentialStrategy;
73-
_badMessagesCount: number;
74-
_reconnectAttempt: number;
75-
_options: RPC_ClientOptions;
76-
_connectionUrl: string;
77-
_connectPromise: Promise<{
78-
response: any;
79-
}>;
80-
_nextPingTimeout: NodeJS.Timeout;
40+
protected _identity?: string;
41+
private _wildcardHandler;
42+
private _handlers;
43+
protected _state: number;
44+
private _callQueue;
45+
protected _ws?: WebSocket;
46+
private _wsAbortController?;
47+
private _keepAliveAbortController?;
48+
private _pendingPingResponse;
49+
private _lastPingTime;
50+
private _closePromise?;
51+
private _protocolOptions;
52+
protected _protocol?: string;
53+
private _strictProtocols;
54+
private _strictValidators?;
55+
private _pendingCalls;
56+
private _pendingResponses;
57+
private _outboundMsgBuffer;
58+
private _connectedOnce;
59+
private _backoffStrategy?;
60+
private _badMessagesCount;
61+
private _reconnectAttempt;
62+
protected _options: RPC_ClientOptions;
63+
private _connectionUrl;
64+
private _connectPromise;
65+
private _nextPingTimeout;
8166
static OPEN: number;
8267
static CONNECTING: number;
8368
static CLOSING: number;
@@ -92,22 +77,17 @@ declare class RPC_Client extends EventEmitter {
9277
* @returns {Promise<undefined>} Resolves when connected, rejects on failure
9378
*/
9479
connect(): Promise<any>;
95-
_keepAlive(): Promise<void>;
96-
_tryReconnect(): Promise<void>;
97-
_beginConnect(): Promise<{
98-
response: any;
99-
}>;
80+
private _keepAlive;
81+
private _tryReconnect;
82+
private _beginConnect;
10083
/**
10184
* Start consuming from a WebSocket
10285
* @param {WebSocket} ws - A WebSocket instance
10386
* @param {EventBuffer} leadMsgBuffer - A buffer which traps all 'message' events
10487
*/
105-
_attachWebsocket(ws: WebSocket, leadMsgBuffer?: EventBuffer): void;
106-
_handleDisconnect({ code, reason }: {
107-
code: number;
108-
reason: Buffer;
109-
}): void;
110-
_rejectPendingCalls(abortReason: string): void;
88+
protected _attachWebsocket(ws: WebSocket, leadMsgBuffer?: EventBuffer): void;
89+
private _handleDisconnect;
90+
private _rejectPendingCalls;
11191
/**
11292
* Call a method on a remote RPCClient or RPCServerClient.
11393
* @param {string} method - The RPC method to call.
@@ -119,7 +99,7 @@ declare class RPC_Client extends EventEmitter {
11999
* @returns Promise<*> - Response value from the remote handler.
120100
*/
121101
call(method: any, params?: any, options?: Record<string, any>): Promise<unknown>;
122-
_call(method: any, params: any, options?: Record<string, any>): Promise<any>;
102+
private _call;
123103
/**
124104
* Closes the RPCClient.
125105
* @param {Object} options - Close options
@@ -139,12 +119,12 @@ declare class RPC_Client extends EventEmitter {
139119
code: number | undefined;
140120
reason: string | undefined;
141121
} | undefined>;
142-
_awaitUntilPendingSettled(): Promise<PromiseSettledResult<any>[]>;
143-
_deferNextPing(): void;
144-
_onMessage(buffer: Buffer): void;
145-
_onCall(msgId: string, method: string, params: any): Promise<void>;
146-
_onCallResult(msgId: string, result: any): any;
147-
_onCallError(msgId: string, errorCode: string, errorDescription: string, errorDetails: Record<string, any>): void;
122+
private _awaitUntilPendingSettled;
123+
private _deferNextPing;
124+
private _onMessage;
125+
private _onCall;
126+
private _onCallResult;
127+
private _onCallError;
148128
/**
149129
* Send a message to the RPCServer. While socket is connecting, the message is queued and send when open.
150130
* @param {Buffer|String} message - String to send via websocket

lib/event-buffer.d.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
/// <reference types="node" />
33
import { EventEmitter } from "stream";
44
declare class EventBuffer {
5-
_emitter: EventEmitter;
6-
_event: string | symbol;
7-
_collector: (...args: any) => void;
8-
_buffer: any;
5+
private _emitter;
6+
private _event;
7+
private _collector;
8+
private _buffer;
99
constructor(emitter: EventEmitter, event: string | symbol);
1010
condense(): any;
1111
}

lib/queue.d.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
declare class Queue {
2-
_pending: number;
3-
_concurrency: number;
4-
_queue: any[];
2+
private _pending;
3+
private _concurrency;
4+
private _queue;
55
constructor();
66
setConcurrency(concurrency: number): void;
77
push(fn: any): Promise<unknown>;
8-
_next(): Promise<false | undefined>;
8+
private _next;
99
}
1010
export default Queue;

lib/server.d.ts

+10-15
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
/// <reference types="node" />
55
/// <reference types="node" />
66
import { IncomingMessage, Server } from "http";
7-
import { ServerOptions, WebSocket, WebSocketServer } from "ws";
7+
import { ServerOptions } from "ws";
88
import { EventEmitter } from "stream";
99
import { Validator } from "./validator";
10-
import RpcServerClient, { IHandshakeInterface } from "./serverClient";
10+
import { IHandshakeInterface } from "./serverClient";
1111
import { Socket } from "net";
1212
interface IOccpServiceOptions {
1313
wssOptions?: ServerOptions;
@@ -21,23 +21,18 @@ interface IOccpServiceOptions {
2121
strictMode?: boolean | string[];
2222
strictModeValidators?: Validator[];
2323
}
24-
interface TPendingUpgrades {
25-
session: Record<string, any>;
26-
protocol: string;
27-
handshake: IHandshakeInterface;
28-
}
2924
declare class RPCServer extends EventEmitter {
30-
_httpServerAbortControllers: Set<AbortController>;
31-
_state: number;
32-
_clients: Set<RpcServerClient>;
33-
_pendingUpgrades: WeakMap<IncomingMessage, TPendingUpgrades>;
34-
_options: IOccpServiceOptions;
35-
_wss: WebSocketServer;
36-
_strictValidators: Map<string, Validator>;
25+
private _httpServerAbortControllers;
26+
private _state;
27+
private _clients;
28+
private _pendingUpgrades;
29+
private _options;
30+
private _wss;
31+
private _strictValidators;
3732
authCallback: (accept: (session?: Record<string, any>, protocol?: string | false) => void, reject: (code: number, message: string) => void, handshake: IHandshakeInterface, signal: AbortSignal) => void;
3833
constructor({ ...options }: IOccpServiceOptions, _callback?: () => void);
3934
reconfigure(options: any): void;
40-
_onConnection(websocket: WebSocket, request: IncomingMessage): Promise<void>;
35+
private _onConnection;
4136
get handleUpgrade(): (request: IncomingMessage, socket: Socket, head: Buffer) => Promise<void>;
4237
auth(cb: (accept: (session?: Record<string, any>, protocol?: string | false) => void, reject: (code: number, message: string) => void, handshake: IHandshakeInterface, signal?: AbortSignal) => void): void;
4338
listen(port: any, host?: any, options?: Record<string, any>): Promise<Server<typeof IncomingMessage, typeof import("http").ServerResponse>>;

lib/serverClient.d.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ export interface IHandshakeInterface {
1414
password: Buffer | undefined;
1515
}
1616
declare class RpcServerClient extends RPC_Client {
17-
_session: Record<string, any>;
18-
_handshake: IHandshakeInterface;
17+
private _session;
18+
private _handshake;
1919
constructor({ ...options }: RPC_ClientOptions, { ws, handshake, session, }: {
2020
ws: WebSocket;
2121
session: Record<string, any>;

0 commit comments

Comments
 (0)