octyne-api

A JavaScript API wrapper for retrixe/octyne.

Installation

octyne-api makes use of Promises, async functions and ES2015 classes, and thus requires Node.js 8+ (only 10+ is officially supported) or a modern evergreen browser. However, you can import octyne-api/ie9 to use the library on older browsers like Internet Explorer 9 (requires a polyfill like core-js).

npm install octyne-api
# or
yarn add octyne-api

Usage

octyne-api is built around a Client class which performs all requests.

View the docs for the latest release here.

// Short program to get the uptime of a process running on an Octyne instance.
const OctyneApi = require('octyne-api') // You can name it anything e.g. Client.
const ms = require('ms')

const client = OctyneApi('http://localhost:42069', {
  username: 'user', password: 'pass' // You can also pass a token for direct usage.
})

client.login().then(async () => {
  const server = await client.getServer('servername')
  console.log(ms(server.uptime, { long: true }))
  await client.logout()
}).catch(err => console.error(err))

For a full list of methods and properties available on the master branch, you can also look at the typings file here.

License

MIT License

Copyright (c) 2020 Sanguineous1

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.