Logo for jsDocs.io

ink

  • Version 6.5.1
  • Published
  • 344 kB
  • 23 dependencies
  • MIT license

Install

npm i ink
yarn add ink
pnpm add ink

Overview

React for CLI

Index

Classes

Type Aliases

Classes

class Ink

class Ink {}

    constructor

    constructor(options: Options);

      property calculateLayout

      calculateLayout: () => void;

        property getTerminalWidth

        getTerminalWidth: () => number;

          property onRender

          onRender: () => void;

            property rejectExitPromise

            rejectExitPromise: (reason?: Error) => void;

              property resized

              resized: () => void;

                property resolveExitPromise

                resolveExitPromise: () => void;

                  property unsubscribeExit

                  unsubscribeExit: () => void;

                    method clear

                    clear: () => void;

                      method patchConsole

                      patchConsole: () => void;

                        method render

                        render: (node: ReactNode) => void;

                          method unmount

                          unmount: (error?: Error | number | null) => void;

                            method waitUntilExit

                            waitUntilExit: () => Promise<void>;

                              method writeToStderr

                              writeToStderr: (data: string) => void;

                                method writeToStdout

                                writeToStdout: (data: string) => void;

                                  Type Aliases

                                  type Options

                                  type Options = {
                                      stdout: NodeJS.WriteStream;
                                      stdin: NodeJS.ReadStream;
                                      stderr: NodeJS.WriteStream;
                                      debug: boolean;
                                      exitOnCtrlC: boolean;
                                      patchConsole: boolean;
                                      onRender?: (metrics: RenderMetrics) => void;
                                      isScreenReaderEnabled?: boolean;
                                      waitUntilExit?: () => Promise<void>;
                                      maxFps?: number;
                                      incrementalRendering?: boolean;
                                  };

                                    type RenderMetrics

                                    type RenderMetrics = {
                                        /**
                                        Time spent rendering in milliseconds.
                                        */
                                        renderTime: number;
                                    };

                                    • Performance metrics for a render operation.

                                    Package Files (1)

                                    Dependencies (23)

                                    Dev Dependencies (29)

                                    Peer Dependencies (3)

                                    Badge

                                    To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                    You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/ink.

                                    • Markdown
                                      [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/ink)
                                    • HTML
                                      <a href="https://www.jsdocs.io/package/ink"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>