-
Notifications
You must be signed in to change notification settings - Fork 29.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: explain differences in console.assert between node and browsers #6169
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -109,6 +109,45 @@ console.assert(false, 'Whoops %s', 'didn\'t work'); | |
// AssertionError: Whoops didn't work | ||
``` | ||
|
||
It is important to note that the `console.assert()` method in Node.js is | ||
implemented differently than the `console.assert()` method available in | ||
browsers. Specifically, in browsers, calling `console.assert()` with a falsy | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Was wondering to rather have it as general Note: Specifically, in browsers, calling There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. perhapse a link to https://developer.mozilla.org/en-US/docs/Web/API/console/assert |
||
assertion will cause the `message` to be printed to the console without | ||
interrupting execution of subsequent code. In Node.js, however, a falsy | ||
assertion will cause an `AssertionError` to be thrown. | ||
|
||
Functionality approximating that implemented by browsers can be implemented | ||
by extending Node.js' `console` and overriding the `console.assert()` method. | ||
|
||
In the following example, a simple module is created that extends and overrides | ||
the default behavior of `console` in Node.js. | ||
|
||
```js | ||
'use strict'; | ||
|
||
// Creates a simple extension of console with a | ||
// new impl for assert without monkey-patching. | ||
const myConsole = Object.setPrototypeOf({ | ||
assert(assertion, message, ...args) { | ||
try { | ||
console.assert(assertion, message, ...args); | ||
} catch (err) { | ||
console.error(err.stack); | ||
} | ||
} | ||
}, console); | ||
|
||
module.exports = myConsole; | ||
``` | ||
|
||
This can then be used as a direct replacement for the built in console: | ||
|
||
```js | ||
const console = require('./myConsole'); | ||
console.assert(false, 'this message will print, but no error thrown'); | ||
console.log('this will also print'); | ||
``` | ||
|
||
### console.dir(obj[, options]) | ||
|
||
Uses [`util.inspect()`][] on `obj` and prints the resulting string to `stdout`. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
perhaps a link to https://developer.mozilla.org/en-US/docs/Web/API/Console