Merge pull request #812 from microsoft/tyriar/buffer

Support Buffer in write API

Author: Tyriar

src/interfaces.ts

@@ -22,7 +22,7 @@ export interface ITerminal {
    * Writes data to the socket.
    * @param data The data to write.
    */
-  write(data: string): void;
+  write(data: string | Buffer): void;
 
   /**
    * Resize the pty.

src/terminal.test.ts

@@ -23,7 +23,7 @@ class TestTerminal extends Terminal {
   public checkType<T>(name: string, value: T, type: string, allowArray: boolean = false): void {
     this._checkType(name, value, type, allowArray);
   }
-  protected _write(data: string): void {
+  protected _write(data: string | Buffer): void {
     throw new Error('Method not implemented.');
   }
   public resize(cols: number, rows: number): void {

src/terminal.ts

@@ -74,9 +74,9 @@ export abstract class Terminal implements ITerminal {
     this._checkType('encoding', opt.encoding ? opt.encoding : undefined, 'string');
   }
 
-  protected abstract _write(data: string): void;
+  protected abstract _write(data: string | Buffer): void;
 
-  public write(data: string): void {
+  public write(data: string | Buffer): void {
     if (this.handleFlowControl) {
       // PAUSE/RESUME messages are not forwarded to the pty
       if (data === this._flowControlPause) {

src/unixTerminal.ts

@@ -161,7 +161,7 @@ export class UnixTerminal extends Terminal {
     this._forwardEvents();
   }
 
-  protected _write(data: string): void {
+  protected _write(data: string | Buffer): void {
     this._socket.write(data);
   }
 

src/windowsTerminal.ts

@@ -123,11 +123,11 @@ export class WindowsTerminal extends Terminal {
     this._forwardEvents();
   }
 
-  protected _write(data: string): void {
+  protected _write(data: string | Buffer): void {
     this._defer(this._doWrite, data);
   }
 
-  private _doWrite(data: string): void {
+  private _doWrite(data: string | Buffer): void {
     this._agent.inSocket.write(data);
   }
 

typings/node-pty.d.ts

@@ -173,7 +173,7 @@ declare module 'node-pty' {
      * Writes data to the pty.
      * @param data The data to write.
      */
-    write(data: string): void;
+    write(data: string | Buffer): void;
 
     /**
      * Kills the pty.