Updated readme.md
This commit is contained in:
parent
9be67bf7c7
commit
b5ed21755d
31
README.md
31
README.md
|
@ -1,20 +1,22 @@
|
||||||
# eventstore-node
|
# eventstore-node
|
||||||
A port of the EventStore .Net ClientAPI to Node.js
|
A port of the EventStore .Net ClientAPI to Node.js
|
||||||
|
|
||||||
# Porting .Net Task to Node.js
|
## Porting .Net Task to Node.js
|
||||||
|
|
||||||
I used Promise to replace .Net Task, so when executing an async command, i.e. appendToStream you'll have to wait for result/error like this:
|
I used Promise to replace .Net Task, so when executing an async command, i.e. appendToStream you'll have to wait for result/error like this:
|
||||||
|
|
||||||
connection
|
connection
|
||||||
.appendToStream('myStream', client.expectedVersion.any, events, userCredentials)
|
.appendToStream('myStream', client.expectedVersion.any, events, userCredentials)
|
||||||
.then(function(result) {
|
.then(function(result) {
|
||||||
//Do something with the WriteResult here
|
//Do something with the WriteResult here
|
||||||
})
|
})
|
||||||
.catch(function(err) {
|
.catch(function(err) {
|
||||||
//Handle error here
|
//Handle error here
|
||||||
});
|
});
|
||||||
|
|
||||||
# Status
|
## Status
|
||||||
|
|
||||||
|
Unstable
|
||||||
|
|
||||||
Incomplete/missing features:
|
Incomplete/missing features:
|
||||||
|
|
||||||
|
@ -24,9 +26,9 @@ Incomplete/missing features:
|
||||||
- Set system settings: not implemented yet
|
- Set system settings: not implemented yet
|
||||||
- Performance: there's still some while loop in the code that could be problematic with node.js
|
- Performance: there's still some while loop in the code that could be problematic with node.js
|
||||||
- Tests: tests are only covering happy path scenarios for now
|
- Tests: tests are only covering happy path scenarios for now
|
||||||
- NPM package: no package released yet, I will release one when code is production ready
|
- NPM package: no package released yet, I will release one when code is stable
|
||||||
|
|
||||||
# Running the tests
|
## Running the tests
|
||||||
You will need:
|
You will need:
|
||||||
|
|
||||||
- dependencies (npm install)
|
- dependencies (npm install)
|
||||||
|
@ -36,3 +38,8 @@ You will need:
|
||||||
To execute the tests suites simply run test with npm
|
To execute the tests suites simply run test with npm
|
||||||
|
|
||||||
npm test
|
npm test
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
This is a port, original code is released under the EventStore license and can be found at https://github.com/eventstore/eventstore.
|
||||||
|
Ported code is released under the MIT license, see https://github.com/nicdex/eventstore-node/blob/master/LICENSE
|
||||||
|
|
Loading…
Reference in New Issue
Block a user