Skip to content
A Node.js wrapper for the Digital Ocean v2 API
TypeScript JavaScript
Branch: master
Clone or download

Latest commit

Latest commit 9e34020 May 6, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Remove donations, add FUNDING.yml Jul 29, 2019
dist Update dependencies and docs Mar 15, 2020
docs Update dependencies and docs Mar 15, 2020
scripts Remove v4 notification warning Jan 24, 2020
src fixes #40 Mar 15, 2020
test 🐛 Fix tests Jun 19, 2018
.gitignore Boilerplating Aug 25, 2019
.npmignore Add .gitignore Mar 15, 2020
.travis.yml Add further testing support Aug 17, 2019
LICENSE Update LICENSE file Jan 24, 2020
README.md Update README May 6, 2020
package-lock.json 4.0.0 May 6, 2020
package.json 4.0.0 May 6, 2020
tsconfig.json Update tsconfig.json Jan 24, 2020

README.md

do-wrapper

A Node.js wrapper for the Digital Ocean v2 API

Build Status Dependencies Downloads Known Vulnerabilities

Install

do-wrapper is available on the npm repository and as such, can be installed with npm.

To install do-wrapper and add it to your package.json, use the following command:

$ npm install --save do-wrapper

Usage

In order to use the library, you'll first need to provision a Personal Access Token for your Digital Ocean account.

Once you've got a Personal Access Token, make a note of this somewhere safe, as you won't be able to view it again.

In your project, initialise a new instance of the Digital Ocean wrapper:

const DigitalOcean = require("do-wrapper").default;

const instance = new DigitalOcean('{personal_access_token}');

Once you've created an instance, you can use it to access the many groups of features provided by the wrapper, like so:

instance.account.get()
    .then(data => console.log(data))
    .catch(err => console.error(err));

Note: you can view the data behind the error by accessing err.response, this is provided by the underlying request library

The available features are:

  • account
  • actions
  • cdn
  • certificates
  • databases
  • domains
  • droplets
  • firewalls
  • floatingIPs
  • images
  • keys
  • kubernetes
  • loadBalancers
  • projects
  • regions
  • reports
  • sizes
  • snapshots
  • tags
  • volumes

License

The MIT License (MIT)

Copyright (c) 2020 Matt Major

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.

You can’t perform that action at this time.