Skip to content

Commit

Permalink
Make most callback errors and accept / reject functions have undefine…
Browse files Browse the repository at this point in the history 
…d unions (DefinitelyTyped#42077)
  • Loading branch information
@wbobeirne
wbobeirne authored Feb 10, 2020
1 parent 05ae673 commit 2e019e5
Showing 1 changed file with 36 additions and 34 deletions.
70 changes: 36 additions & 34 deletions types/ssh2/index.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ export class Client extends events.EventEmitter {
* @param options Options for the command.
* @param callback The callback to execute when the command has completed.
*/
exec(command: string, options: ExecOptions, callback: (err: Error, channel: ClientChannel) => void): boolean;
exec(command: string, options: ExecOptions, callback: (err: Error | undefined, channel: ClientChannel) => void): boolean;

/**
* Executes a command on the server.
Expand All @@ -259,7 +259,7 @@ export class Client extends events.EventEmitter {
* @param command The command to execute.
* @param callback The callback to execute when the command has completed.
*/
exec(command: string, callback: (err: Error, channel: ClientChannel) => void): boolean;
exec(command: string, callback: (err: Error | undefined, channel: ClientChannel) => void): boolean;

/**
* Starts an interactive shell session on the server.
Expand All @@ -270,7 +270,7 @@ export class Client extends events.EventEmitter {
* @param options Options for the command.
* @param callback The callback to execute when the channel has been created.
*/
shell(window: PseudoTtyOptions | false, options: ShellOptions, callback: (err: Error, channel: ClientChannel) => void): boolean;
shell(window: PseudoTtyOptions | false, options: ShellOptions, callback: (err: Error | undefined, channel: ClientChannel) => void): boolean;

/**
* Starts an interactive shell session on the server.
Expand All @@ -280,7 +280,7 @@ export class Client extends events.EventEmitter {
* @param window Either an object containing containing pseudo-tty settings, `false` to suppress creation of a pseudo-tty.
* @param callback The callback to execute when the channel has been created.
*/
shell(window: PseudoTtyOptions | false, callback: (err: Error, channel: ClientChannel) => void): boolean;
shell(window: PseudoTtyOptions | false, callback: (err: Error | undefined, channel: ClientChannel) => void): boolean;

/**
* Starts an interactive shell session on the server.
Expand All @@ -290,7 +290,7 @@ export class Client extends events.EventEmitter {
* @param options Options for the command.
* @param callback The callback to execute when the channel has been created.
*/
shell(options: ShellOptions, callback: (err: Error, channel: ClientChannel) => void): boolean;
shell(options: ShellOptions, callback: (err: Error | undefined, channel: ClientChannel) => void): boolean;

/**
* Starts an interactive shell session on the server.
Expand All @@ -299,7 +299,7 @@ export class Client extends events.EventEmitter {
*
* @param callback The callback to execute when the channel has been created.
*/
shell(callback: (err: Error, channel: ClientChannel) => void): boolean;
shell(callback: (err: Error | undefined, channel: ClientChannel) => void): boolean;

/**
* Bind to `remoteAddr` on `remotePort` on the server and forward incoming TCP connections.
Expand All @@ -320,7 +320,7 @@ export class Client extends events.EventEmitter {
* @param remotePort The remote port to bind on the server. If this value is `0`, the actual bound port is provided to `callback`.
* @param callback An optional callback that is invoked when the remote address is bound.
*/
forwardIn(remoteAddr: string, remotePort: number, callback?: (err: Error, bindPort: number) => void): boolean;
forwardIn(remoteAddr: string, remotePort: number, callback?: (err: Error | undefined, bindPort: number) => void): boolean;

/**
* Unbind from `remoteAddr` on `remotePort` on the server and stop forwarding incoming TCP
Expand All @@ -332,7 +332,7 @@ export class Client extends events.EventEmitter {
* @param remotePort The remote port to unbind on the server.
* @param callback An optional callback that is invoked when the remote address is unbound.
*/
unforwardIn(remoteAddr: string, remotePort: number, callback?: (err: Error) => void): boolean;
unforwardIn(remoteAddr: string, remotePort: number, callback?: (err: Error | undefined) => void): boolean;

/**
* Open a connection with `srcIP` and `srcPort` as the originating address and port and
Expand All @@ -346,7 +346,7 @@ export class Client extends events.EventEmitter {
* @param dstPort The destination port.
* @param callback The callback that is invoked when the address is bound.
*/
forwardOut(srcIP: string, srcPort: number, dstIP: string, dstPort: number, callback: (err: Error, channel: ClientChannel) => void): boolean;
forwardOut(srcIP: string, srcPort: number, dstIP: string, dstPort: number, callback: (err: Error | undefined, channel: ClientChannel) => void): boolean;

/**
* Starts an SFTP session.
Expand All @@ -355,7 +355,7 @@ export class Client extends events.EventEmitter {
*
* @param callback The callback that is invoked when the SFTP session has started.
*/
sftp(callback: (err: Error, sftp: SFTPWrapper) => void): boolean;
sftp(callback: (err: Error | undefined, sftp: SFTPWrapper) => void): boolean;

/**
* Invokes `subsystem` on the server.
Expand All @@ -365,7 +365,7 @@ export class Client extends events.EventEmitter {
* @param subsystem The subsystem to start on the server.
* @param callback The callback that is invoked when the subsystem has started.
*/
subsys(subsystem: string, callback: (err: Error, channel: ClientChannel) => void): boolean;
subsys(subsystem: string, callback: (err: Error | undefined, channel: ClientChannel) => void): boolean;

/**
* Disconnects the socket.
Expand All @@ -383,31 +383,31 @@ export class Client extends events.EventEmitter {
*
* Returns `false` if you should wait for the `continue` event before sending any more traffic.
*/
openssh_noMoreSessions(callback?: (err: Error) => void): boolean;
openssh_noMoreSessions(callback?: (err: Error | undefined) => void): boolean;

/**
* OpenSSH extension that binds to a UNIX domain socket at `socketPath` on the server and
* forwards incoming connections.
*
* Returns `false` if you should wait for the `continue` event before sending any more traffic.
*/
openssh_forwardInStreamLocal(socketPath: string, callback?: (err: Error) => void): boolean;
openssh_forwardInStreamLocal(socketPath: string, callback?: (err: Error | undefined) => void): boolean;

/**
* OpenSSH extension that unbinds from a UNIX domain socket at `socketPath` on the server
* and stops forwarding incoming connections.
*
* Returns `false` if you should wait for the `continue` event before sending any more traffic.
*/
openssh_unforwardInStreamLocal(socketPath: string, callback?: (err: Error) => void): boolean;
openssh_unforwardInStreamLocal(socketPath: string, callback?: (err: Error | undefined) => void): boolean;

/**
* OpenSSH extension that opens a connection to a UNIX domain socket at `socketPath` on
* the server.
*
* Returns `false` if you should wait for the `continue` event before sending any more traffic.
*/
openssh_forwardOutStreamLocal(socketPath: string, callback?: (err: Error, channel: ClientChannel) => void): boolean;
openssh_forwardOutStreamLocal(socketPath: string, callback?: (err: Error | undefined, channel: ClientChannel) => void): boolean;
}

export interface ConnectConfig {
Expand Down Expand Up @@ -697,7 +697,7 @@ export class Server extends events.EventEmitter {
/**
* Asynchronously get the number of concurrent connections on the server.
*/
getConnections(callback: (err: Error, count: number) => void): void;
getConnections(callback: (err: Error | undefined, count: number) => void): void;

/**
* Stops the server from accepting new connections and keeps existing connections. This
Expand All @@ -708,7 +708,7 @@ export class Server extends events.EventEmitter {
* Unlike that event, it will be called with an `Error` as its only argument if the
* server was not open when it was closed.
*/
close(callback?: (err: Error) => void): this;
close(callback?: (err: Error | undefined) => void): this;

/**
* Opposite of `unref`, calling `ref` on a previously unrefd server will not let the
Expand Down Expand Up @@ -791,18 +791,18 @@ export interface Connection extends events.EventEmitter {
* Emitted when the client has sent a global request for name.
* If info.bindPort === 0, you should pass the chosen port to accept so that the client will know what port was bound.
*/
on(event: "request", listener: (accept: (chosenPort?: number) => void, reject: () => void, name: "tcpip-forward" | "cancel-tcpip-forward", info: TcpipBindInfo) => void): this;
on(event: "request", listener: (accept: ((chosenPort?: number) => void) | undefined, reject: (() => void) | undefined, name: "tcpip-forward" | "cancel-tcpip-forward", info: TcpipBindInfo) => void): this;

/**
* Emitted when the client has sent a global request for name.
*/
on(event: "request", listener: (accept: () => void, reject: () => void, name: "[email protected]" | "[email protected]", info: SocketBindInfo) => void): this;
on(event: "request", listener: (accept: (() => void) | undefined, reject: () => void, name: "[email protected]" | "[email protected]", info: SocketBindInfo) => void): this;

/**
* Emitted when the client has sent a global request for name.
* If info.bindPort === 0, you should pass the chosen port to accept so that the client will know what port was bound.
*/
on(event: "request", listener: (accept: (chosenPort?: number) => void, reject: () => void, name: string, info: TcpipBindInfo | SocketBindInfo) => void): this;
on(event: "request", listener: (accept: ((chosenPort?: number) => void) | undefined, reject: (() => void) | undefined, name: string, info: TcpipBindInfo | SocketBindInfo) => void): this;

/**
* Emitted when the client has finished rekeying (either client or server initiated).
Expand Down Expand Up @@ -848,15 +848,15 @@ export interface Connection extends events.EventEmitter {
*
* Returns `false` if you should wait for the `continue` event before sending any more traffic.
*/
x11(originAddr: string, originPort: number, callback: (err: Error, channel: ServerChannel) => void): boolean;
x11(originAddr: string, originPort: number, callback: (err: Error | undefined, channel: ServerChannel) => void): boolean;

/**
* Alert the client of an incoming TCP connection on `boundAddr` on port `boundPort` from
* `remoteAddr` on port `remotePort`.
*
* Returns `false` if you should wait for the `continue` event before sending any more traffic.
*/
forwardOut(boundAddr: string, boundPort: number, remoteAddr: string, remotePort: number, callback: (err: Error, channel: ServerChannel) => void): boolean;
forwardOut(boundAddr: string, boundPort: number, remoteAddr: string, remotePort: number, callback: (err: Error | undefined, channel: ServerChannel) => void): boolean;

/**
* Initiates a rekeying with the client.
Expand All @@ -865,7 +865,7 @@ export interface Connection extends events.EventEmitter {
*
* @param callback An optional callback added as a one-time handler for the `rekey` event.
*/
rekey(callback?: (err: Error) => void): boolean;
rekey(callback?: (err: Error | undefined) => void): boolean;

/**
* Alert the client of an incoming UNIX domain socket connection on socketPath.
Expand Down Expand Up @@ -906,7 +906,7 @@ export interface AuthContextBase extends events.EventEmitter {
/**
* Emitted when the client aborts the authentication request.
*/
on(event: "abort", listener: (err: Error) => void): this;
on(event: "abort", listener: () => void): this;

on(event: string | symbol, listener: Function): this;
}
Expand Down Expand Up @@ -1022,58 +1022,60 @@ export interface SocketBindInfo {
socketPath: string;
}

type SessionAcceptReject = (() => boolean) | undefined

export interface Session extends events.EventEmitter {
// Session events

/**
* Emitted when the client requested allocation of a pseudo-TTY for this session.
*/
on(event: "pty", listener: (accept: () => boolean, reject: () => boolean, info: PseudoTtyInfo) => void): this;
on(event: "pty", listener: (accept: SessionAcceptReject, reject: SessionAcceptReject, info: PseudoTtyInfo) => void): this;

/**
* Emitted when the client reported a change in window dimensions during this session.
*/
on(event: "window-change", listener: (accept: () => boolean, reject: () => boolean, info: WindowChangeInfo) => void): this;
on(event: "window-change", listener: (accept: SessionAcceptReject, reject: SessionAcceptReject, info: WindowChangeInfo) => void): this;

/**
* Emitted when the client requested X11 forwarding.
*/
on(event: "x11", listener: (accept: () => boolean, reject: () => boolean, info: X11Info) => void): this;
on(event: "x11", listener: (accept: SessionAcceptReject, reject: SessionAcceptReject, info: X11Info) => void): this;

/**
* Emitted when the client requested an environment variable to be set for this session.
*/
on(event: "env", listener: (accept: () => boolean, reject: () => boolean, info: SetEnvInfo) => void): this;
on(event: "env", listener: (accept: SessionAcceptReject, reject: SessionAcceptReject, info: SetEnvInfo) => void): this;

/**
* Emitted when the client has sent a POSIX signal.
*/
on(event: "signal", listener: (accept: () => boolean, reject: () => boolean, info: SignalInfo) => void): this;
on(event: "signal", listener: (accept: SessionAcceptReject, reject: SessionAcceptReject, info: SignalInfo) => void): this;

/**
* Emitted when the client has requested incoming ssh-agent requests be forwarded to them.
*/
on(event: "auth-agent", listener: (accept: () => boolean, reject: () => boolean) => void): this;
on(event: "auth-agent", listener: (accept: SessionAcceptReject, reject: SessionAcceptReject) => void): this;

/**
* Emitted when the client has requested an interactive shell.
*/
on(event: "shell", listener: (accept: () => ServerChannel, reject: () => boolean) => void): this;
on(event: "shell", listener: (accept: SessionAcceptReject, reject: SessionAcceptReject) => void): this;

/**
* Emitted when the client has requested execution of a command string.
*/
on(event: "exec", listener: (accept: () => ServerChannel, reject: () => boolean, info: ExecInfo) => void): this;
on(event: "exec", listener: (accept: SessionAcceptReject, reject: SessionAcceptReject, info: ExecInfo) => void): this;

/**
* Emitted when the client has requested the SFTP subsystem.
*/
on(event: "sftp", listener: (accept: () => SFTPStream, reject: () => boolean) => void): this;
on(event: "sftp", listener: (accept: SessionAcceptReject, reject: SessionAcceptReject) => void): this;

/**
* Emitted when the client has requested an arbitrary subsystem.
*/
on(event: "subsystem", listener: (accept: () => ServerChannel, reject: () => boolean, info: SubsystemInfo) => void): this;
on(event: "subsystem", listener: (accept: SessionAcceptReject, reject: SessionAcceptReject, info: SubsystemInfo) => void): this;

/**
* Emitted when the session has closed.
Expand Down

0 comments on commit 2e019e5

Please sign in to comment.