docs(NODE-3363): added docs for proposed error hierarchy #2862
Conversation
andymina
changed the title
andymina
changed the title
| @@ -95,6 +95,38 @@ describe('GridFS Stream', function () { | |||
| } | |||
| }); | |||
|
|
|||
| it('destroy publishes provided error', { | |||
There was a problem hiding this comment.
What's this test here doing?
There was a problem hiding this comment.
@nbbeeken I think this test was here already, but it got scooped into this PR after we rebased onto the most recent 4.0 branch. We may have some git-fu to figure out to get rid of that change in this PR.
There was a problem hiding this comment.
Can we leave this comment open until the mysterious test is taken care of?
There was a problem hiding this comment.
Had a few points of discussion but this is looking great, nice job! 👍
I noticed some of the errors in the graphs, like MongoNoCursorInChangeStreamError, aren't also in the markdown text. Would you be able to add any errors that are only in the graph to the markdown, so that we can reference them more easily in the review?
docs/errors.md
Outdated
|
|
||
| ## `MongoNetworkError` | ||
|
|
||
| These are errors encountered at runtime which occur when the driver encounters an issue in the network which leads to an inability to connect to a mongo server instance. Children of this class include: |
There was a problem hiding this comment.
We should find a way to phrase it as less of a run on sentence
docs/errors.md
Outdated
|
|
||
| - #### `MongoNetworkTimeoutError` | ||
|
|
||
| - Thrown when a timeout expires in attempting to connect to the mongo server |
There was a problem hiding this comment.
| - Thrown when a timeout expires in attempting to connect to the mongo server | |
| - Thrown when a timeout expires while attempting to connect to the mongo server. |
This is working properly on 4.x - this is just a test to avoid any regressions.
andymina
force-pushed
the
NODE-3363/4.0/error-hierarchy
branch
from
b3e6a38 to
0d69383
Compare
Co-authored-by: Warren James <[email protected]>
Description
docs/errors.mdwhich details the proposed new error class hierarchy.