https://github.com/sindresorhus/get-stdin

Get stdin as a string or buffer
https://github.com/sindresorhus/get-stdin

Last synced: 6 days ago
JSON representation

Get stdin as a string or buffer

• Host: GitHub
• URL: https://github.com/sindresorhus/get-stdin
• Owner: sindresorhus
• License: mit
• Created: 2014-02-13T18:33:12.000Z (almost 11 years ago)
• Default Branch: main
• Last Pushed: 2023-10-15T07:54:04.000Z (about 1 year ago)
• Last Synced: 2024-11-28T18:41:27.907Z (14 days ago)
• Language: JavaScript
• Homepage:
• Size: 37.1 KB
• Stars: 337
• Watchers: 9
• Forks: 28
• Open Issues: 2
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/funding.yml
  • License: license
  • Security: .github/security.md

Awesome Lists containing this project

• awesome-nodejs-cn - get-stdin - 简单的 stdin (包 / 命令行工具)
• awesome-nodejs - get-stdin - Easier stdin. (Packages / Command-line utilities)
• awesome-npm - get-stdin - 获取标准输入流的工具 (3. 命令行程序 / 3.1 开发库)
• awesome-nodejs - get-stdin - Get stdin as a string or buffer - ★ 186 (Command-line utilities)
• awesome-node - get-stdin - Easier stdin. (Packages / Command-line utilities)
• awesome-nodejs-cn - get-stdin - 简单的 stdin输出. (目录 / 命令行工具)
• awesome-nodejs-cn - get-stdin - **star:337** 简单的 stdin (包 / 命令行实用工具)

README

        
# get-stdin

> Get [stdin](https://nodejs.org/api/process.html#process_process_stdin) as a string or buffer

## Install

```sh

npm install get-stdin

```

## Usage

```js

// example.js

import getStdin from 'get-stdin';

console.log(await getStdin());

//=> 'unicorns'

```

```

$ echo unicorns | node example.js

unicorns

```

## API

Both methods returns a promise that is resolved when the `end` event fires on the `stdin` stream, indicating that there is no more data to be read.

### getStdin()

Get `stdin` as a `string`.

In a TTY context, a promise that resolves to an empty `string` is returned.

### getStdin.buffer()

Get `stdin` as a `Buffer`.

In a TTY context, a promise that resolves to an empty `Buffer` is returned.

## Tip

You can now accomplish this natively in Node.js using [`streamConsumers.text()`](https://nodejs.org/api/webstreams.html#streamconsumerstextstream) or [`streamConsumers.buffer()`](https://nodejs.org/api/webstreams.html#streamconsumersbufferstream):

```js

// example.js

import {text} from 'node:stream/consumers';

console.log(await text(stream))

//=> 'unicorns'

````

```

$ echo unicorns | node example.js

unicorns

```

## Related

- [get-stream](https://github.com/sindresorhus/get-stream) - Get a stream as a string or buffer