Skip to content
This repository has been archived by the owner on Feb 19, 2024. It is now read-only.

computology/packagecloud.js

Repository files navigation

Build status

packagecloud.js

JavaScript library for communicating with the packagecloud.io API.

Implemented API Endpoints

Installation

npm install packagecloud

or

yarn add packagecloud

Creating a Client

In the browser:

// i.e., Rails with a sprockets manifest
//= require packagecloud/dist/packagecloud.browser.js
...
// main.js
var pc = new packagecloud({token:'your_api_token', baseUrl:'https://packagecloud.io'});

Or in a NodeJS environment:

import PackageCloud from "packagecloud";
const pc = new packagecloud({token:'your_api_token', baseUrl:'https://packagecloud.io'});

Result objects

Every client API method call returns a Promise object, which is "thenable". For example, the following code will fetch a list of distributions and return a promise object that allows us to define what happens on success, or failure.

var success = function(data) {
  console.log("success!", data);
}
var error = function(err) {
  console.log("error!", error);
}
pc.getDistribution().then(success, error)

Copyright

Copyright (c) 2018 Computology, LLC

See LICENSE file for details.