nefertiti-node
Version:
ES module to work with Nefertiti crypto trade bot.
121 lines (89 loc) • 4.33 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>api/update.js - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
<script src="scripts/nav.js" defer></script>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav >
<h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#deleteBot">deleteBot</a></li><li><a href="global.html#downloadNefertiti">downloadNefertiti</a></li><li><a href="global.html#filterMarketsByCurrency">filterMarketsByCurrency</a></li><li><a href="global.html#getAvailableMarkets">getAvailableMarkets</a></li><li><a href="global.html#getCurrentNefVersion">getCurrentNefVersion</a></li><li><a href="global.html#getSupportedExchanges">getSupportedExchanges</a></li><li><a href="global.html#pingBot">pingBot</a></li><li><a href="global.html#pingHub">pingHub</a></li><li><a href="global.html#postBot">postBot</a></li><li><a href="global.html#sendNotificationsTest">sendNotificationsTest</a></li><li><a href="global.html#updateBot">updateBot</a></li><li><a href="global.html#updateNef">updateNef</a></li></ul>
</nav>
<div id="main">
<h1 class="page-title">api/update.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>/* eslint-disable no-use-before-define */
import axios from 'axios';
import { nefertitiURL as nef } from '../functions/variables.js';
/**
* @function updateBot
* @description Issue a POST request to update a specific bot
* @param {string|number} port - Port of the bot to update
* @param {object} args - Object keys are Nefertiti flags with appropriate values {'mult': 1.05}
* @returns {Promise<array>} - Returns an array of objects with running bot information. Should be chained with '.then()'
* @example
*
* updateBot(38702, { mult: '1.1' }).then((res) => {
* console.log(res)
* }
*
*/
export default async function updateBot(port, args = {}) {
try {
// make sure we're getting all the parameters we need
if (!port || !args) {
throw new Error('you are missing a mandatory parameter');
}
// convert args into url search params
const urlBody = new URLSearchParams({ ...args });
// initiate fetch
const response = await axios.post(`${nef.hostname}:${port}${nef.post}`, urlBody.toString());
return response.data;
} catch (err) {
const errObj = {
// if there's an error code, we want it. if not, we want to return the error status
statusCode: err.toJSON().code ? err.toJSON().code : err.response.status,
errorMessage:
err.toJSON().code === 'ECONNREFUSED'
? 'There was an error connecting to Nefertiti. This usually means the listen server has not started, or cannot be reached at 127.0.0.1:38700'
: stripErrorMessage(err.response.data.toString()),
};
return errObj;
}
}
/**
* @private
* @param {string} err - error string from axios
* @returns {string} - Substring of error message beginning with the first '['
*/
function stripErrorMessage(err) {
const msg = err.substring(err.indexOf('['), err.indexOf('\n'));
return msg;
}
</code></pre>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Sat Dec 18 2021 15:50:34 GMT-0600 (Central Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/polyfill.js"></script>
<script src="scripts/linenumber.js"></script>
</body>
</html>