ink
Version:
React for CLI
16 lines (15 loc) • 709 B
TypeScript
export type Props = {
/**
Stdout stream passed to `render()` in `options.stdout` or `process.stdout` by default.
*/
readonly stdout: NodeJS.WriteStream;
/**
Write any string to stdout while preserving Ink's output. It's useful when you want to display external information outside of Ink's rendering and ensure there's no conflict between the two. It's similar to `<Static>`, except it can't accept components; it only works with strings.
*/
readonly write: (data: string) => void;
};
/**
`StdoutContext` is a React context that exposes the stdout stream where Ink renders your app.
*/
declare const StdoutContext: import("react").Context<Props>;
export default StdoutContext;