# packagecloud

> JavaScript API client for packagecloud.io

Latest version **0.2.2** (published 2019-05-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install packagecloud
pnpm add packagecloud
yarn add packagecloud
bun add packagecloud
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.2 |
| Published | 2019-05-06 |
| First published | 2018-01-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 4.0 |
| Dependencies | 1 |
| Unpacked size | 1.4 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Armando Canals |
| Maintainers | armandocanals |
| Keywords | package-management |

## Links

- npm: https://www.npmjs.com/package/packagecloud
- Repository: https://github.com/computology/packagecloud.js
- Homepage: https://github.com/computology/packagecloud.js#readme
- Issues: https://github.com/computology/packagecloud.js/issues
- npm.io page: https://npm.io/package/packagecloud

## Dependencies (1)

- [superagent](https://npm.io/package/superagent.md) ^3.8.3

## Recent versions

- 0.2.2 (latest) — 2019-05-06
- 0.2.1 — 2018-07-22
- 0.2.0 — 2018-07-11
- 0.1.1 — 2018-07-09
- 0.1.0 — 2018-01-24

## README

[![Build status](https://badge.buildkite.com/9791e408006343258cbdf3e383b6e6f5f662256438604923ae.svg)](https://buildkite.com/packagecloud/packagecloud-dot-js)

## packagecloud.js

JavaScript library for communicating with the [packagecloud.io](https://packagecloud.io) API.

* [Email](mailto:support@packagecloud.io)


## Implemented API Endpoints

* [Create Repository](https://packagecloud.io/docs/api#resource_repositories_method_create)
* [Delete Package](https://packagecloud.io/docs/api#resource_packages_method_destroy)
* [Get Distributions](https://packagecloud.io/docs/api#resource_distributions_method_index)
* [Get Repositories](https://packagecloud.io/docs/api#resource_repositories_method_index)
* [Get Repository](https://packagecloud.io/docs/api#resource_repositories_method_show)
* [List Debian and RPM Packages](https://packagecloud.io/docs/api#resource_packages_method_show)
* [List RubyGem, Python, and Java Packages](https://packagecloud.io/docs/api#resource_packages_method_gem_show)
* [Upload Package](https://packagecloud.io/docs/api#resource_packages_method_create)
* [Promote Package](https://packagecloud.io/docs/api#resource_packages_method_promote)

## Installation

  ```bash
npm install packagecloud
  ```
  or
  ```bash
yarn add packagecloud
  ```

## Creating a Client
In the browser:
```javascript
// 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:
```javascript
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.

```javascript
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.

---
_Source: https://npm.io/package/packagecloud · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._