From 5af3c17284d2e2b91047e9b1d698e45edc660351 Mon Sep 17 00:00:00 2001
From: Daniel Imms <tyriar@tyriar.com>
Date: Fri, 21 Dec 2018 11:29:55 -0800
Subject: [PATCH] Elaborate on experimentalUseConpty setting

---
 src/interfaces.ts     | 2 +-
 typings/node-pty.d.ts | 6 ++++--
 2 files changed, 5 insertions(+), 3 deletions(-)

diff --git a/src/interfaces.ts b/src/interfaces.ts
index d2ffb8844..cd5774837 100644
--- a/src/interfaces.ts
+++ b/src/interfaces.ts
@@ -116,7 +116,7 @@ export interface IPtyForkOptions {
   uid?: number;
   gid?: number;
   encoding?: string;
-  experimentalUseConpty?: boolean;
+  experimentalUseConpty?: boolean | undefined;
 }
 
 export interface IPtyOpenOptions {
diff --git a/typings/node-pty.d.ts b/typings/node-pty.d.ts
index 822a07444..3f3819ba6 100644
--- a/typings/node-pty.d.ts
+++ b/typings/node-pty.d.ts
@@ -26,8 +26,10 @@ declare module 'node-pty' {
     gid?: number;
     encoding?: string;
     /**
-     * Whether to use the experimental ConPTY system on Windows. This setting will be ignored on
-     * non-Windows.
+     * Whether to use the experimental ConPTY system on Windows. When this is not set, ConPTY will
+     * be used when the Windows build number is >= 17692.
+     *
+     * This setting does nothing on non-Windows.
      */
     experimentalUseConpty?: boolean;
   }