Bitfinex Honey Framework LowDB Adapter for Node.JS
This is an adapter around lowdb (a lodash-powered JSON database) for the Bitfinex Honey Framework. To use, initialize an instance of the bfx-hf-models
database with it as an adapter.
Features
lowdb
saves the DB contents as a JSON file on disk- No need to run a 3rd party database server instance
- Fully compatible with
bfx-hf-models
& the HF system (bfx-hf-data-server
,bfx-hf-algo-server
,bfx-hf-algo
, etc)
Installation
npm i --save bfx-hf-models-adapter-lowdb
Quickstart & Example
const HFDBLowDBAdapter = const schema: HFDBBitfinexSchema = const HFDB = const LOWDB_FILENAME = '...' const db = schema: HFDBBitfinexSchema adapter: const Candle = dbconst candles = await Candle console
Docs
Refer to the examples/
folder for executable examples. For information on the available model methods, check the documentation for bfx-hf-models
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request