daawesomep / vyltr Goto Github PK

View Code? Open in Web Editor NEW

This project forked from hugomd/vyltr

0.0 3.0 0.0 250 KB

🍬 A Vultr API wrapper

Home Page: https://vyltr-docs.now.sh/classes/Vultr.html

JavaScript 100.00%

vyltr's Introduction

Vyltr — Vultr API Wrapper 🍬

An API wrapper for the Vultr API.

Note: this is a work in progress.

Usage

Documentation is available here.

Example

const Vultr = require('vyltr');

// Pass API Token as parameter.
const v = new Vultr('VULTR_API_TOKEN');

const list = async () => {
  try {
    // List available Vultr plans
    const list = await v.plan.list();

    // Returns an array of PlanModel objects
    console.log(list);
  } catch (err) {
    console.log(err);
  }
}

list();

Outputs:

[ PlanModel {
    VPSPLANID: '87',
    name: '512 MB RAM,125 GB SATA,1.00 TB BW',
    vcpu_count: '1',
    ram: '512',
    disk: '125',
    bandwidth: '1.00',
    price_per_month: '5.00',
    windows: false,
    plan_type: 'SATA',
    available_locations: [ 1, 5, 7 ] },
  PlanModel {
    VPSPLANID: '88',
    name: '1024 MB RAM,250 GB SATA,2.00 TB BW',
    vcpu_count: '1',
    ram: '1024',
    disk: '250',
    bandwidth: '2.00',
    price_per_month: '10.00',
    windows: false,
    plan_type: 'SATA',
    available_locations: [ 1 ] },
  PlanModel {
    VPSPLANID: '89',
    name: '2048 MB RAM,500 GB SATA,3.00 TB BW',
    vcpu_count: '1',
    ram: '2048',
    disk: '500',
    bandwidth: '3.00',
    price_per_month: '20.00',
    windows: false,
    plan_type: 'SATA',
    available_locations: [ 1 ] },

    ...
]