diff options
| author | Rich Trott <rtrott@gmail.com> | 2018-04-17 22:17:20 -0700 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2018-04-18 10:01:08 -0700 |
| commit | 52491529ba940faa6d69b20bb5fe89ae3b3e137c (patch) | |
| tree | 74ce1dfea9dc30365bbf00c5ac89cc27d3d5870b /test/common/README.md | |
| parent | f565bbb193c90a974ad1500b86047b834d58606d (diff) | |
| download | android-node-v8-52491529ba940faa6d69b20bb5fe89ae3b3e137c.tar.gz android-node-v8-52491529ba940faa6d69b20bb5fe89ae3b3e137c.tar.bz2 android-node-v8-52491529ba940faa6d69b20bb5fe89ae3b3e137c.zip | |
doc: fix misplaced entries in test/common doc
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>
Diffstat (limited to 'test/common/README.md')
| -rw-r--r-- | test/common/README.md | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/test/common/README.md b/test/common/README.md index 981e27a26b..08d7bbb762 100644 --- a/test/common/README.md +++ b/test/common/README.md @@ -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 to indicate this. -### noWarnCode -See `common.expectWarning()` for usage. - ### fileExists(pathname) * pathname [<string>] * return [<boolean>] @@ -147,13 +144,11 @@ consisting of all `ArrayBufferView` and an `ArrayBuffer`. Returns the file name and line number for the provided Function. -### runWithInvalidFD(func) -* `func` [<Function>] +### getTTYfd() -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. +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. ### globalCheck * [<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` otherwise. +### noWarnCode +See `common.expectWarning()` for usage. + ### opensslCli * [<boolean>] @@ -369,6 +367,14 @@ original state after calling [`common.hijackStdOut()`][]. Path to the 'root' directory. either `/` or `c:\\` (windows) +### runWithInvalidFD(func) +* `func` [<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) * `msg` [<string>] @@ -695,12 +701,6 @@ The realpath of 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 The wpt.js module is a port of parts of |