Skip to content

Commit 7575a16

Browse files
author
Ruben Bridgewater
committed
chore(doc): add changelog entry and add error classes to the readme
1 parent 3acf3dd commit 7575a16

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,11 @@ var myParser = new Parser(options);
3535
* `setReturnBuffers(boolean)`: (JSParser only) set the returnBuffers option on/off without resetting the parser
3636
* `setStringNumbers(boolean)`: (JSParser only) set the stringNumbers option on/off without resetting the parser
3737

38+
### Error classes
39+
40+
All errors returned by the parser are of the class `ReplyError` that is a sub class of `RedisError`.
41+
Both types are exported by the parser.
42+
3843
### Example
3944

4045
```js

changelog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Features
55
- Added `reset` function to reset the parser to it's initial values
66
- Added `setReturnBuffers` function to reset the returnBuffers option (Only for the JSParser)
77
- Added `setStringNumbers` function to reset the stringNumbers option (Only for the JSParser)
8+
- All Errors are now of sub classes of the new `RedisError` class. It is also exported.
89

910
Bugfixes
1011

0 commit comments

Comments
 (0)