tap
Version:
A Test-Anything-Protocol library for JavaScript
24 lines (23 loc) • 1.11 kB
TypeScript
/// <reference types="node" />
/// <reference types="react" />
export interface Props {
/**
* Stdin stream passed to `render()` in `options.stdin` or `process.stdin` by default. Useful if your app needs to handle user input.
*/
readonly stdin?: NodeJS.ReadStream;
/**
* Ink exposes this function via own `<StdinContext>` to be able to handle Ctrl+C, that's why you should use Ink's `setRawMode` instead of `process.stdin.setRawMode`.
* If the `stdin` stream passed to Ink does not support setRawMode, this function does nothing.
*/
readonly setRawMode: (value: boolean) => void;
/**
* A boolean flag determining if the current `stdin` supports `setRawMode`. A component using `setRawMode` might want to use `isRawModeSupported` to nicely fall back in environments where raw mode is not supported.
*/
readonly isRawModeSupported: boolean;
readonly internal_exitOnCtrlC: boolean;
}
/**
* `StdinContext` is a React context, which exposes input stream.
*/
declare const StdinContext: import("react").Context<Props>;
export default StdinContext;