Add the event doc
#1745
Closed
Add the event doc
#1745
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Please help me to improve the writing, my English is so bad :(
leibale
requested review from
guyroyse and
simonprickett
and removed request for
simonprickett
|
Thanks for the contribution, @AnnAngela. Very helpful. I'd like to edit it a bit for grammar and spelling. Can you grant me access to do so? Thanks! |
|
Yes, I am very grateful for your willingness to help me!
|
guyroyse
requested changes
Nov 30, 2021
|
|
||
| Node Redis client class extends Node.js's `EventEmitter` class, and the client emits an event each time the network status changes: | ||
|
|
||
| | Event name | Scenes | Parameters | |
There was a problem hiding this comment.
Can we clean up the table format here to be a bit tidier?
There was a problem hiding this comment.
I like to use this site: http://markdowntable.com/
| | error | When a network error has occurred, such as unable to connect to the server or the connection closed unexpectedly | The error object, such as `SocketClosedUnexpectedlyError: Socket closed unexpectedly` or `Error: connect ECONNREFUSED [IP]:[PORT]` | | ||
| | reconnecting | The client is trying to reconnect to the server. | _undefined_ | ||
|
|
||
| Except for the network, the client will not emmit any events any more. |
There was a problem hiding this comment.
The client will not emit any other events beyond those listed abovee.
There was a problem hiding this comment.
Doh! I spelled above wrong. ;)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Checklist
npm testpass with this change (including linting)?The PR only changes a doc.
Please help me to improve the writing, my English is so bad :(