nefertiti-node

0.0.2 • Public • Published

nefertiti-node

Version Documentation Maintenance License: GPL3

nefertiti-node is a node.js library of useful tools and utilities for working with Nefertiti crypto trading bot

📚 Documentation

🛠️ Usage

nefertiti-node is a hybrid/dual package offering both ESM and CommonJS.

## Install with npm:
npm i nefertiti-node

Use as an ES module:

// Import the plugin to your project:
import nefertiti from 'nefertiti-node';

// console log the object
console.log(nefertiti);

// and use a function:
nefertiti.functions.getSupportedExchanges();

Use as a CommonJS module:

// Require the plugin
const nefertiti = require('nefertiti-node');

// console log the object
console.log(nefertiti);

// and use a function:
nefertiti.functions.getSupportedExchanges();

Output from console.log(nefertiti):

  [Module: null prototype] {
    apis: [Module: null prototype] {
      deleteBot: [Function: deleteBot],
      pingBot: [AsyncFunction: pingBot],
      pingHub: [AsyncFunction: pingHub],
      postBot: [AsyncFunction: post],
      updateBot: [AsyncFunction: updateBot]
    },
    functions: [Module: null prototype] {
      filterMarketsByCurrency: [Function: filterMarketsByCurrency],
      getAvailableMarkets: [Function: getAvailableMarkets],
      getCurrentNefVersion: [Function: checkNefVersion],
      getSupportedExchanges: [Function: getSupportedExchanges],
      sendNotificationsTest: [Function: sendNotificationsTest],
      startNefListenServer: [Function: startNefListenServer],
      startNefListenServerAsync: [AsyncFunction: startNefListenServerAsync],
      updateNef: [Function: updateNef]
    },
    helpers: [Module: null prototype] {
      downloadNefertiti: [Function: downloadNefertitiFromGithub],
      getArch: [Function: getArch],
      getPlatform: [Function: getPlatform]
    },
    variables: [Module: null prototype] {
      currentDirectory: 'nefertiti-node',
      executable: 'nefertiti-node\\bin\\nefertiti_windows_amd64.exe',
      executableName: 'nefertiti_windows_amd64',
      executablePath: 'nefertiti-node\\bin',
      nefertitiURL: {
        hostname: 'http://127.0.0.1',
        port: 38700,
        ping: '/ping',
        post: '/post'
      }
    }
  }

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check the issues page.

👏 Show your support

Give a ⭐️ if this project helped you!
Join the 💬 Nefertiti Telegram
Visit my blog and get in touch!

🤪 Author

👤 d00vy | the@d00vy.com

📝 License

Copyright © 2021 d00vy | the@d00vy.com.
This project is GPL-3 licensed.


Investing in crypto is high risk. Only use these tools if you understand and accept these risks.

Package Sidebar

Install

npm i nefertiti-node

Weekly Downloads

4

Version

0.0.2

License

GPL-3.0

Unpacked Size

1.36 MB

Total Files

92

Last publish

Collaborators

  • d00vy