Merge pull request #4485 from enlight/pty.js-typings2

Add type definitions for pty.js

pty.js/pty.js-tests.ts

@@ -0,0 +1,21 @@
+/// <reference path="pty.js.d.ts" />
+
+import pty = require('pty.js');
+
+var term: pty.Terminal = pty.spawn('bash', [], {
+    name: 'xterm-color',
+    cols: 80,
+    rows: 30,
+    cwd: process.env.HOME,
+    env: process.env
+});
+
+term.on('data', function(data: any) {
+    console.log(data);
+});
+
+term.write('ls\r');
+term.resize(100, 40);
+term.write('ls /\r');
+
+console.log(term.process);

pty.js/pty.js.d.ts

@@ -0,0 +1,133 @@
+// Type definitions for pty.js 0.2.7-1
+// Project: https://github.com/chjj/pty.js
+// Definitions by: Vadim Macagon <https://github.com/enlight/>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../node/node.d.ts" />
+
+declare module 'pty.js' {
+    /** Options that can be used when creating a new pseudo-terminal. */
+    interface TerminalOptions {
+        name?: string;
+        cols?: number;
+        rows?: number;
+        cwd?: string;
+        env?: any;
+        uid?: number;
+        gid?: number;
+    }
+
+    import stream = require('stream');
+    import net = require('net');
+
+    export class Terminal implements stream.Stream {
+        /** Read-only name of the terminal. */
+        name: string;
+        /** Read-only number of columns in the terminal. */
+        cols: number;
+        /** Read-only number of rows in the terminal. */
+        rows: number;
+        /**
+         * Read-only identifier of the spawned process associated with the slave end of the 
+         * pseudo-terminal. This will be null if the terminal was created via [[Terminal.open]].
+         */
+        pid: number;
+        /** Read-only file descriptor of the master end of the pseudo-terminal. */
+        fd: number;
+        /** Read-only name of the slave end of the pseudo-terminal. */
+        pty: string;
+        /** Read-only filename of the executable associated with the slave end of the pseudo-terminal. */
+        file: string;
+        /** Read-only name of the process associated with the slave end of the pseudo-terminal. */
+        process: string;
+        stdout: Terminal;
+        /** Note that an exception will be thrown if an attempt is made to access this property. */
+        stderr: Terminal;
+        stdin: Terminal;
+        socket: net.Socket;
+
+        /** 
+         * Creates a new pseudo-terminal, spawns a child process, and associates it with the slave 
+         * end of the pseudo-terminal.
+         */
+        constructor(file?: string, args?: string[], opt?: TerminalOptions);
+
+        resize(cols?: number, rows?: number): void;
+        /** 
+         * Sends a signal to the spawned process associated with the slave end of the
+         * pseudo-terminal (this only works if [[pid]] is not null).
+         */
+        kill(signal?: string): void;
+        redraw(): void;
+    
+        // NodeJS Socket-like interface (wrappers for this.socket)
+        
+        write(data: any): boolean;
+        end(data: any): void;
+        pause(): void;
+        resume(): void;
+        setEncoding(encoding: string): void;
+        /** 
+         * Closes the master end of the pseudo-terminal, and attempts to kill the spawned process
+         * associated with the slave end of the pseudo-terminal (but only if [[pid]] is not null).
+         */
+        destroy(): void;
+
+        // NodeJS Stream interface
+    
+        pipe<T extends NodeJS.WritableStream>(destination: T, options?: { end?: boolean; }): T;
+    
+        // NodeJS EventEmitter interface
+    
+        addListener(event: string, listener: Function): NodeJS.EventEmitter;
+        on(event: string, listener: Function): NodeJS.EventEmitter;
+        once(event: string, listener: Function): NodeJS.EventEmitter;
+        removeListener(event: string, listener: Function): NodeJS.EventEmitter;
+        removeAllListeners(event?: string): NodeJS.EventEmitter;
+        // NOTE: this method is not actually defined in pty.js
+        setMaxListeners(n: number): void;
+        listeners(event: string): Function[];
+        emit(event: string, ...args: any[]): boolean;
+    }
+
+    /** 
+     * Creates a new pseudo-terminal, spawns a child process, and associates it with the slave 
+     * end of the pseudo-terminal.
+     */
+    export function createTerminal(file?: string, args?: string[], opt?: TerminalOptions): Terminal;
+    /** Alias for [[createTerminal]]. */
+    export function fork(file?: string, args?: string[], opt?: TerminalOptions): Terminal;
+    /** Alias for [[createTerminal]]. */
+    export function spawn(file?: string, args?: string[], opt?: TerminalOptions): Terminal;
+    /** 
+     * Creates a new pseudo-terminal.
+     * This function is not available on Windows, use [[fork]] there instead.
+     */
+    export function open(opt?: { cols?: number; rows?: number }): Terminal;
+    
+    // Internal stuff that probably isn't very useful but is exported by pty.js
+    export module native {
+        /** Unix-only. */
+        export function fork(
+            file: string, args: string[], env: any, cwd: string, cols: number, rows: number,
+            uid?: number, gid?: number
+        ): { fd: number; pid: number; pty: string };
+        /** Unix-only. */
+        export function open(
+            cols: number, rows: number
+        ): { master: number; slave: number; pty: string };
+        /** Unix-only. */
+        export function process(fd: number, tty: string): string;
+        /** Windows-only. */
+        export function open(
+            dataPipe: string, cols: number, rows: number, debug: boolean
+        ): { pid: number; pty: number; fd: number };
+        /** Windows-only. */
+        export function startProcess(
+            pid: number, file: string, cmdline: string, env: string[], cwd: string
+        ): void;
+        /** Windows-only. */
+        export function kill(pid: number): void;
+        export function resize(fd: number, cols: number, rows: number): void;
+    }
+}