diff options
| author | Eugene Y. Q. Shen <eugene@eyqs.ca> | 2018-08-01 16:05:22 -0700 |
|---|---|---|
| committer | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-08-02 17:36:27 +0300 |
| commit | ce98e2e989ec52f6aa205c8b340ff214aba5f060 (patch) | |
| tree | 7c9a43966daeae274d1079923384d8d681d4d1ef /doc/api/assert.md | |
| parent | a3e511b97109d58e1fa4cf2220b7a96aedd0f724 (diff) | |
| download | android-node-v8-ce98e2e989ec52f6aa205c8b340ff214aba5f060.tar.gz android-node-v8-ce98e2e989ec52f6aa205c8b340ff214aba5f060.tar.bz2 android-node-v8-ce98e2e989ec52f6aa205c8b340ff214aba5f060.zip | |
doc: rename stackStartFunction in assert.md
[assert.js](https://github.com/nodejs/node/blob/master/lib/assert.js)
uses `stackStartFn` everywhere instead of `stackStartFunction`.
This also increases consistency with `stackStartFn`
in the `AssertionError` options.
PR-URL: https://github.com/nodejs/node/pull/22077
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Diffstat (limited to 'doc/api/assert.md')
| -rw-r--r-- | doc/api/assert.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/api/assert.md b/doc/api/assert.md index 57fcc14de2..baa7c2f8aa 100644 --- a/doc/api/assert.md +++ b/doc/api/assert.md @@ -587,7 +587,7 @@ assert.fail(new TypeError('need array')); Using `assert.fail()` with more than two arguments is possible but deprecated. See below for further details. -## assert.fail(actual, expected[, message[, operator[, stackStartFunction]]]) +## assert.fail(actual, expected[, message[, operator[, stackStartFn]]]) <!-- YAML added: v0.1.21 changes: @@ -600,7 +600,7 @@ changes: * `expected` {any} * `message` {string|Error} * `operator` {string} **Default:** `'!='` -* `stackStartFunction` {Function} **Default:** `assert.fail` +* `stackStartFn` {Function} **Default:** `assert.fail` > Stability: 0 - Deprecated: Use `assert.fail([message])` or other assert > functions instead. @@ -610,7 +610,7 @@ If `message` is falsy, the error message is set as the values of `actual` and `expected` arguments are provided, `operator` will default to `'!='`. If `message` is provided as third argument it will be used as the error message and the other arguments will be stored as properties on the thrown object. If -`stackStartFunction` is provided, all stack frames above that function will be +`stackStartFn` is provided, all stack frames above that function will be removed from stacktrace (see [`Error.captureStackTrace`]). If no arguments are given, the default message `Failed` will be used. @@ -636,7 +636,7 @@ assert.fail(1, 2, new TypeError('need array')); In the last three cases `actual`, `expected`, and `operator` have no influence on the error message. -Example use of `stackStartFunction` for truncating the exception's stacktrace: +Example use of `stackStartFn` for truncating the exception's stacktrace: ```js function suppressFrame() { |