nefertiti-node
Version:
ES module to work with Nefertiti crypto trade bot.
101 lines (70 loc) • 3.37 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>api/delete.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/delete.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>/* eslint-disable no-console */
import axios from 'axios';
import { nefertitiURL as nef } from '../functions/variables.js';
/**
* @function deleteBot
* @description Function to stop and remove a bot.
*
* * Does NOT consider cancelling orders
*
* @param {string|number} port The port number of the bot to stop/remove
* @returns {Error} return an error as of Nov 2021
*
* @example // just issue the command directly, but expect no response:
*
* deleteBot(38701)
*/
export default function deleteBot(port) {
console.log(`Sending request to delete bot ${port}...`);
// eslint-disable-next-line consistent-return
axios.delete(`${nef.hostname}:${port}`).catch((err) => {
if (err.code === 'ECONNREFUSED') {
return `Delete failed: no bot found at port ${port}`;
}
if (err.code === 'ECONNRESET') {
return `Deleted bot ${port}`;
}
});
console.log(`Deleted bot ${port}`);
}
</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>