ttys

Guaranteed read and write streams to the terminal

ttys

Guaranteed read and write streams to the terminal

This micro module provides tty.ReadStreamand tty.WriteStreaminstances to the user's terminal, even when the regular stdinor stdoutstreams are already being piped to other commands.

Installation

Install with npm:

$ npm install ttys

The setup

Suppose you want to provide a curl | nodecommand to your users.

The script could be something as simple as printing "Hello World" and exiting.

// script.js
console.log('Hello World')

Place that on your websever and have your users invoke the command:

$ curl aweso.me/script.js | node
Hello World

Awesome!!!

The problem

Now suppose that you wanted to alter script.jsto prompt the user for their name, so that you can personalize it a little bit.

The problem is that process.stdinis used up because it gets piped from the curl command, and ends before node runs the script. If you try to call process.stdin.resume()and listen for "data" and "end" events, you will see that the "end" event will be fired immediately.

The solution

Using ttys, you can get guaranteed access to a stdinreadable stream and stdoutwritable stream. It's easy!

var ttys = require('ttys')
var readline = require('readline')

var i = readline.createInterface(ttys.stdin, ttys.stdout)
i.question('What is your name? ', function (name) {
  console.log('Hello %s', name)

  i.close()
  ttys.stdin.pause()
})

Now when your users run the script, then they will be prompted as you would expect:

$ curl aweso.me/script.js | node
What is your name? Nathan
Hello Nathan

That's it!

License

(The MIT License)

Copyright (c) 2012 Nathan Rajlich <nathan@tootallnate.net>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Repository

https://github.com/TooTallNate/ttys


上一篇:bbb
下一篇:sonar-web-frontend-reporters

相关推荐

  • prettysize

    Convert bytes to other sizes for prettier logging PrettySize ========== Helper utility to provide ...

    2 年前
  • mattys_discord_bot

    This is a Bot for Discord, made and maintained by Matthijs Kramer, it does not have specific functio...

    5 个月前
  • mattys-api

    This is an api for node.js modules made by Matthijs Kramer mattysapi CDN by jsDelivr A...

    4 个月前
  • bunyan-prettystream

    A stream implementation of the bunyan cli tool's pretty printing capabilities Build Status(https:...

    10 个月前

官方社区

扫码加入 JavaScript 社区