1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: fix misplaced entries in test/common doc

Browse Source 
One entry is placed in the wrong module and other entries are not in
alphabetical order.

PR-URL: https://github.com/nodejs/node/pull/20117
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
This commit is contained in:
Rich Trott 2018-04-17 22:17:20 -07:00
parent f565bbb193
commit 52491529ba
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
test/common/README.md
View File

@ -119,9 +119,6 @@ Tests whether `name`, `expected`, and `code` are part of a raised warning. If
an expected warning does not have a code then `common.noWarnCode` can be used an expected warning does not have a code then `common.noWarnCode` can be used
to indicate this. to indicate this.
### noWarnCode
See `common.expectWarning()` for usage.
### fileExists(pathname) ### fileExists(pathname)
* pathname [&lt;string>] * pathname [&lt;string>]
* return [&lt;boolean>] * return [&lt;boolean>]
@ -147,13 +144,11 @@ consisting of all `ArrayBufferView` and an `ArrayBuffer`.
Returns the file name and line number for the provided Function. Returns the file name and line number for the provided Function.
### runWithInvalidFD(func) ### getTTYfd()
* `func` [&lt;Function>]
Runs `func` with an invalid file descriptor that is an unsigned integer and Attempts to get a valid TTY file descriptor. Returns `-1` if it fails.
can be used to trigger `EBADF` as the first argument. If no such file
descriptor could be generated, a skip message will be printed and the `func` The TTY file descriptor is assumed to be capable of being writable.
will not be run.
### globalCheck ### globalCheck
* [&lt;boolean>] * [&lt;boolean>]
@ -328,6 +323,9 @@ Returns `true` if the exit code `exitCode` and/or signal name `signal` represent
the exit code and/or signal name of a node process that aborted, `false` the exit code and/or signal name of a node process that aborted, `false`
otherwise. otherwise.
### noWarnCode
See `common.expectWarning()` for usage.
### opensslCli ### opensslCli
* [&lt;boolean>] * [&lt;boolean>]
@ -369,6 +367,14 @@ original state after calling [`common.hijackStdOut()`][].
Path to the 'root' directory. either `/` or `c:\\` (windows) Path to the 'root' directory. either `/` or `c:\\` (windows)
### runWithInvalidFD(func)
* `func` [&lt;Function>]
Runs `func` with an invalid file descriptor that is an unsigned integer and
can be used to trigger `EBADF` as the first argument. If no such file
descriptor could be generated, a skip message will be printed and the `func`
will not be run.
### skip(msg) ### skip(msg)
* `msg` [&lt;string>] * `msg` [&lt;string>]
@ -695,12 +701,6 @@ The realpath of the testing temporary directory.
Deletes and recreates the testing temporary directory. Deletes and recreates the testing temporary directory.
### getTTYfd()
Attempts to get a valid TTY file descriptor. Returns `-1` if it fails.
The TTY file descriptor is assumed to be capable of being writable.
## WPT Module ## WPT Module
The wpt.js module is a port of parts of The wpt.js module is a port of parts of