← Back to branch summary

~yolanda.robla/ubuntu/trusty/nodejs/add_distribution

« back to all changes in this revision

Viewing changes to doc/api/api/tty.json

  • Committer: Package Import Robot
  • Author(s): Jérémy Lal
  • Date: 2013-08-14 00:16:46 UTC
  • mfrom: (7.1.40 sid)
  • Revision ID: package-import@ubuntu.com-20130814001646-bzlysfh8sd6mukbo
Tags: 0.10.15~dfsg1-4
* Update 2005 patch, adding a handful of tests that can fail on
  slow platforms.
* Add 1004 patch to fix test failures when writing NaN to buffer
  on mipsel.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/api/api/tty.json
1
 
{
2
 
  "source": "doc/api/tty.markdown",
3
 
  "modules": [
4
 
    {
5
 
      "textRaw": "TTY",
6
 
      "name": "tty",
7
 
      "stability": 3,
8
 
      "stabilityText": "Stable",
9
 
      "desc": "<p>Use <code>require(&apos;tty&apos;)</code> to access this module.\n\n</p>\n<p>Example:\n\n</p>\n<pre><code>var tty = require(&apos;tty&apos;);\nprocess.stdin.resume();\ntty.setRawMode(true);\nprocess.stdin.on(&apos;keypress&apos;, function(char, key) {\n  if (key &amp;&amp; key.ctrl &amp;&amp; key.name == &apos;c&apos;) {\n    console.log(&apos;graceful exit&apos;);\n    process.exit()\n  }\n});</code></pre>\n",
10
 
      "methods": [
11
 
        {
12
 
          "textRaw": "tty.isatty(fd)",
13
 
          "type": "method",
14
 
          "name": "isatty",
15
 
          "desc": "<p>Returns <code>true</code> or <code>false</code> depending on if the <code>fd</code> is associated with a\nterminal.\n\n\n</p>\n",
16
 
          "signatures": [
17
 
            {
18
 
              "params": [
19
 
                {
20
 
                  "name": "fd"
21
 
                }
22
 
              ]
23
 
            }
24
 
          ]
25
 
        },
26
 
        {
27
 
          "textRaw": "tty.setRawMode(mode)",
28
 
          "type": "method",
29
 
          "name": "setRawMode",
30
 
          "desc": "<p><code>mode</code> should be <code>true</code> or <code>false</code>. This sets the properties of the current\nprocess&apos;s stdin fd to act either as a raw device or default.\n</p>\n",
31
 
          "signatures": [
32
 
            {
33
 
              "params": [
34
 
                {
35
 
                  "name": "mode"
36
 
                }
37
 
              ]
38
 
            }
39
 
          ]
40
 
        }
41
 
      ],
42
 
      "type": "module",
43
 
      "displayName": "TTY"
44
 
    }
45
 
  ]
46
 
}