diff options
| author | James M Snell <jasnell@gmail.com> | 2017-03-24 09:46:44 -0700 |
|---|---|---|
| committer | James M Snell <jasnell@gmail.com> | 2017-03-26 12:47:15 -0700 |
| commit | 4f2e372716714ed030cb5ba6e67107b913f15343 (patch) | |
| tree | 9b86be4f904c7844c48cca4194f3c3a5a1decad8 /test/README.md | |
| parent | d13bd4acc0b60191f0d6e9fae92087242d04dfbd (diff) | |
| download | android-node-v8-4f2e372716714ed030cb5ba6e67107b913f15343.tar.gz android-node-v8-4f2e372716714ed030cb5ba6e67107b913f15343.tar.bz2 android-node-v8-4f2e372716714ed030cb5ba6e67107b913f15343.zip | |
test: add common.noop, default for common.mustCall()
Export a new common.noop no-operation function for general use.
Allow using common.mustCall() without a fn argument to simplify
test cases.
Replace various non-op functions throughout tests with common.noop
PR-URL: https://github.com/nodejs/node/pull/12027
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Teddy Katz <teddy.katz@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Diffstat (limited to 'test/README.md')
| -rw-r--r-- | test/README.md | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/test/README.md b/test/README.md index ae54942062..b6b21ef772 100644 --- a/test/README.md +++ b/test/README.md @@ -324,7 +324,7 @@ Gets IP of localhost Array of IPV6 hosts. -### mustCall(fn[, expected]) +### mustCall([fn][, expected]) * fn [<Function>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function) * expected [<Number>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type) default = 1 * return [<Function>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function) @@ -333,6 +333,8 @@ Returns a function that calls `fn`. If the returned function has not been called exactly `expected` number of times when the test is complete, then the test will fail. +If `fn` is not provided, `common.noop` will be used. + ### nodeProcessAborted(exitCode, signal) * `exitCode` [<Number>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type) * `signal` [<String>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type) @@ -340,6 +342,18 @@ fail. 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. +### noop + +A non-op `Function` that can be used for a variety of scenarios. + +For instance, + +```js +const common = require('../common'); + +someAsyncAPI('foo', common.mustCall(common.noop)); +``` + ### opensslCli * return [<Boolean>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) |