bfx-api-node-plugin-example

1.0.2 • Public • Published

Bitfinex Example Plugin for the Node.JS API

Build Status

This repo provides an example plugin compatible with bfx-api-node-core which logs all emitted events to the console.

Installation

npm i --save bfx-api-node-plugin-example

Quickstart & Example

const { Manager } = require('bfx-api-node-core')
const ExamplePlugin = require('bfx-api-node-plugin-example')
 
const m = new Manager({
  plugins: [ExamplePlugin()],
  // ...
})
 
m.openWS()

Docs

For a full list of supported events, see lib/plugin.js. For a brief executable example, see examples/ws2_manager_usage.js

For more information on plugin development, check the node API wiki

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

Dependents (0)

Package Sidebar

Install

npm i bfx-api-node-plugin-example

Weekly Downloads

0

Version

1.0.2

License

MIT

Unpacked Size

7.98 kB

Total Files

13

Last publish

Collaborators

  • bitfinexorg
  • vigan-abd
  • prdn