get-stdin

  • Version 10.0.0
  • Published
  • 8.26 kB
  • No dependencies
  • MIT license

Install

npm i get-stdin
yarn add get-stdin
pnpm add get-stdin

Overview

Get stdin as a string or Uint8Array

Index

Variables

Type Aliases

Variables

variable getStdin

const getStdin: {
(options?: Options): Promise<string>;
buffer(options?: Options): Promise<Uint8Array>;
};

    Type Aliases

    type Options

    type Options = {
    /**
    Allow reading from a TTY.
    Use this when you want interactive behavior like `cat` or other Unix filters that wait for EOF even without piped input. The default resolves immediately in a TTY to avoid hanging CLIs that only want piped input and lets them fall back to other input methods.
    @default false
    */
    readonly allowTTY?: boolean;
    /**
    Stream to read from.
    Useful for tests or to read from a custom stream. Defaults to `process.stdin`.
    */
    readonly stdin?: NodeJS.ReadableStream;
    };

      Package Files (1)

      Dependencies (0)

      No dependencies.

      Dev Dependencies (3)

      Peer Dependencies (0)

      No peer dependencies.

      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/get-stdin.

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