bfx-api-node-plugin-managed-ob
Advanced tools
Comparing version
{ | ||
"name": "bfx-api-node-plugin-managed-ob", | ||
"version": "1.0.1", | ||
"version": "1.0.2", | ||
"description": "Maintains complete local order books for the Bitfinex Node API", | ||
@@ -34,4 +34,4 @@ "engines": { | ||
"dependencies": { | ||
"bfx-api-node-core": "git+http://github.com/bitfinexcom/bfx-api-node-core.git#semver:^1.1.0", | ||
"bfx-api-node-models": "git+http://github.com/bitfinexcom/bfx-api-node-models.git#semver:^1.0.12", | ||
"bfx-api-node-core": "^1.1.0", | ||
"bfx-api-node-models": "^1.0.12", | ||
"bluebird": "^3.5.5", | ||
@@ -38,0 +38,0 @@ "debug": "^4.1.1", |
@@ -1,2 +0,2 @@ | ||
# Bitfinex Node API Managed OrderBook Plugin | ||
# Bitfinex Managed OrderBook Plugin for the Node.JS API | ||
@@ -9,8 +9,36 @@ [](https://travis-ci.org/bitfinexcom/bfx-api-node-plugin-managed-ob) | ||
### Example | ||
### Features | ||
* Maintains up-to-date `OrderBook` models internally | ||
* Emits a new 'managed:book' event with a full `OrderBook` instance on each update | ||
### Installation | ||
```bash | ||
npm i --save bfx-api-node-plugin-managed-ob | ||
``` | ||
### Quickstart | ||
```js | ||
'use strict' | ||
const { Manager } = require('bfx-api-node-core') | ||
const ManagedOBPlugin = require('bfx-api-node-plugin-managed-ob') | ||
process.env.DEBUG = '*' | ||
const mgr = new Manager({ | ||
plugins: [ManagedOBPlugin()] | ||
}) | ||
// set up a connection, event listeners, etc | ||
mgr.onWS('managed:book', {}, (ob) => { | ||
debug('checksum: %s', ob.checksum()) | ||
}) | ||
``` | ||
### Docs | ||
For an executable example, [see `examples/usage.js`](/examples/usage.js) | ||
### Example | ||
```js | ||
const debug = require('debug')('bfx:api:plugins:managed-ob:example') | ||
@@ -46,1 +74,9 @@ const { Manager, subscribe } = require('bfx-api-node-core') | ||
``` | ||
### Contributing | ||
1. Fork it | ||
2. Create your feature branch (`git checkout -b my-new-feature`) | ||
3. Commit your changes (`git commit -am 'Add some feature'`) | ||
4. Push to the branch (`git push origin my-new-feature`) | ||
5. Create a new Pull Request |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Git dependency
Supply chain riskContains a dependency which resolves to a remote git URL. Dependencies fetched from git URLs are not immutable and can be used to inject untrusted code or reduce the likelihood of a reproducible install.
Found 2 instances in 1 package
New author
Supply chain riskA new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.
Found 1 instance in 1 package
8281
10.49%81
80%0
-100%0
-100%+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
+ Added
Updated
Updated