npmpackage.info

Gathering detailed insights and metrics for get-stdin-with-tty

Other packages similar to get-stdin-with-tty

@prantlf/get-stdin-with-tty

6.0.1

Get stdin as a string or buffer from pipe or TTY

get-stdin-with-tty

Get stdin as a string or buffer from pipe or TTY (moos fork)

6.0.0

MIT

JavaScript

538.00 B

378,613 1.7

Installations

npm install get-stdin-with-tty

Developer Guide

BETA

Typescript

No

Module System

N/A

Min. Node Version

>=8

Node Version

12.16.1

NPM Version

6.13.4 Score

76.6

Supply Chain

97.9

Quality

75.1

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

1

Closed

0

Merged

1

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View all 1 contributors

Languages

JavaScript

TypeScript

JavaScript (96.68%)

TypeScript (3.32%)

Developer

moos

Download Statistics

Total Downloads

378,613

Last Day

860

Last Week

3,342

Last Month

12,090

Last Year

145,972

GitHub Statistics

2 Stars

68 Commits

1 Forks

3 Watching

1 Branches

1 Contributors

Bundle Size

903.00 B

Minified

538.00 B

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

6.0.0

Package Id

get-stdin-with-tty@6.0.0

Unpacked Size

7.76 kB

Size

3.39 kB

File Count

NPM Version

6.13.4

Node Version

12.16.1

Total Downloads

Cumulative downloads

Total Downloads

378,613

Last day

38.3%

860

Compared to previous day

Last week

19.9%

3,342

Compared to previous week

Last month

-3.9%

12,090

Compared to previous month

Last year

-13.9%

145,972

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@types/node ava delay esm tsd xo

Versions

get-stdin-with-tty

Get stdin as a string or buffer

Install

$ npm install get-stdin-with-tty

Usage

1// example.js
2const getStdin = require('get-stdin-with-tty');
3
4(async () => {
5	console.log(await getStdin());
6})();

$ 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(options) ← Promise<String>

Get stdin as a string.

In a TTY context, a promise that resolves to an empty string is returned, unless options.tty or getStdin.tty is true.

getStdin.buffer() ← Promise<Buffer>

Get stdin as a Buffer.

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

Options / Settings

tty | getStdin.tty (Boolean) - Set global TTY handling. When true, accepts input from TTY until a new line beginning with Ctrl-d or Ctrl-z is entered. Double Ctrl-d anywhere in the line also ends the stream. (Default = true)

When enabled for the example above:
```
$ node example.js
foobar
barfoo
^d
// =>
foobar
barfoo
```
EOF | getStdin.EOF (String) - The end-of-file (aka EOT) character to use to signal end of stream. Defaults to Ctrl-d on *nix and cygwin, and Ctrl-z on Windows. Acceptable values:
- getStdin.CTRL_D - Ctrl-d (ASCII 04)
- getStdin.CTRL_Z - Ctrl-z (ASCII 26)
- '*' - Use both Ctrl-d and Ctrl-z
```
1(win) c:\> node example.js
2foobar
3^z
4# => foobar
```
```
1$ node example.js
2foobar^d^d
3# => foobar
```

Moos Fork

The moos fork includes support for reading stdin from TTY by default.

get-stream - Get a stream as a string or buffer

Change log

6.0.0 - tty option is now defaulted to true. Double Ctrl-d in middle of line also ends stream.
5.0.2 - Initial fork.

License

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.7

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to get-stdin-with-tty

get-stdin-with-tty

Installations

Developer Guide

No

N/A

>=8

12.16.1

6.13.4

Score

Pull Requests

0

1

0

1

Issues

0

0

0

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

Languages

Developer

moos

Download Statistics

GitHub Statistics

Bundle Size

903.00 B

538.00 B

Maintainers

Package Meta Information

Total Downloads

378,613

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

get-stdin-with-tty

Install

Usage

API

getStdin(options) ← Promise<String>

getStdin.buffer() ← Promise<Buffer>

Options / Settings

Moos Fork

Related

Change log

License

10

10

0

0

0

0

0

0

0

0

1.7

/10