0.4.0 • Published 5 years ago

@panda-clouds/docker-machine-providers v0.4.0

Weekly downloads
4
License
MIT
Repository
github
Last release
5 years ago

PCProviders

maintained by PandaClouds.com

PCProviders provides a wrapper for the @panda-clouds/docker-machine npm package for a unified interface in spining up and managing cloud servers.

Installation

  1. If you want to use this library, you first need to install the Node.js.

  2. When you install node.js, will also be installed npm.

  3. Please run the following command.

npm install --save @panda-clouds/docker-machine-providers

Usage

Node.js

const DigitalOcean = require('@panda-clouds/docker-machine-providers').DigitalOcean;

// example usage

Methods

Unit Tests are an additional resource for learning functionality.

- mustExist()

requires the property to be set, else throws error

Example:

Parse.Cloud.beforeSave('Book', request =>{
	const data = new PCProviders(request);
	data.prop('title').mustExist();    // will throw Error if request.object.get('title') doesn't exist
});

Contributions

Pull requests are welcome! here is a checklist to speed things up:

  • modify PCProviders.js
  • add unit tests in PCProviders.spec.js
  • run npm test
  • document method in README.md
  • add your name to 'Contributors' in README.md

Contributors

(Add your name)