Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Mark flow control APIs are experimental #364

Merged
merged 1 commit into from
Oct 22, 2019
Merged

Mark flow control APIs are experimental #364

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions typings/node-pty.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ declare module 'node-pty' {
encoding?: string;

/**
* (EXPERIMENTAL)
* Whether to enable flow control handling (false by default). If enabled a message of `flowControlPause`
* will pause the socket and thus blocking the slave program execution due to buffer back pressure.
* A message of `flowControlResume` will resume the socket into flow mode.
Expand All @@ -63,11 +64,13 @@ declare module 'node-pty' {
handleFlowControl?: boolean;

/**
* (EXPERIMENTAL)
* The string that should pause the pty when `handleFlowControl` is true. Default is XOFF ('\x13').
*/
flowControlPause?: string;

/**
* (EXPERIMENTAL)
* The string that should resume the pty when `handleFlowControl` is true. Default is XON ('\x11').
*/
flowControlResume?: string;
Expand Down Expand Up @@ -124,6 +127,7 @@ declare module 'node-pty' {
readonly process: string;

/**
* (EXPERIMENTAL)
* Whether to handle flow control. Useful to disable/re-enable flow control during runtime.
* Use this for binary data that is likely to contain the `flowControlPause` string by accident.
*/
Expand Down