doc: add throw example #52417
doc: add throw example #52417
Conversation
|
Review requested:
|
nodejs-github-bot
added
doc
|
I'm not sure this belongs in Line 2184 in bf39716 We could add a link to |
the idea is to have one or more examples in |
|
So @aduh95 you thinks it's better to add link to assert instead of having code snippet ? |
|
|
||
| function failFunction() { | ||
| throw new Error('This error will be caught'); | ||
| } | ||
|
|
||
| // It's the way to catch expected errors i your test | ||
| test('test catch error', (t) => { | ||
| assert.throws(() => failFunction(), { | ||
| message: 'This error will be caught', | ||
| }); | ||
| }); |
There was a problem hiding this comment.
Let's remove this one that feels out of place. Instead, what we can do is modify synchronous passing test and asynchronous passing test to include use of assert.throws() and await assert.rejects().
Also, we advice against using error.message to prefer error.code, let's showcase that in our docs.
| function failFunction() { | |
| throw new Error('This error will be caught'); | |
| } | |
| // It's the way to catch expected errors i your test | |
| test('test catch error', (t) => { | |
| assert.throws(() => failFunction(), { | |
| message: 'This error will be caught', | |
| }); | |
| }); |
| error() { | ||
| throw new Error('error'); | ||
| }, |
There was a problem hiding this comment.
This code sample is about mocking methods, I don't think assert.throws has anything to do with it.
| error() { | |
| throw new Error('error'); | |
| }, |
| assert.throws(() => number.error(), { | ||
| message: 'error', | ||
| }); | ||
|
|
There was a problem hiding this comment.
| assert.throws(() => number.error(), { | |
| message: 'error', | |
| }); |
|
I thinks add ressource on learn section is more appropriate |
Add example of throw
Fix: #52357
make lint-js-doc