# cloudconverter

> A simplified interface to the CloudConvert API.

Latest version **1.0.0** (published 2020-02-01) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2020-02-01 |
| First published | 2020-02-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 5 |
| Unpacked size | 5.8 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Richie Bendall |
| Maintainers | richienb |
| Keywords | cloudconvert, api, stream, file, convert, extensions, path, filename, http |

## Links

- npm: https://www.npmjs.com/package/cloudconverter
- Repository: https://github.com/Richienb/cloudconverter
- npm.io page: https://npm.io/package/cloudconverter

## Dependencies (5)

- [ow](https://npm.io/package/ow.md) ^0.15.1
- [got](https://npm.io/package/got.md) ^10.4.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^8.1.0
- [is-stream](https://npm.io/package/is-stream.md) ^2.0.0
- [cloudconvert](https://npm.io/package/cloudconvert.md) ^2.0.0

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2020-02-01

## README

# CloudConverter [![Travis CI Build Status](https://img.shields.io/travis/com/Richienb/cloudconverter/master.svg?style=for-the-badge)](https://travis-ci.com/Richienb/cloudconverter)

A simplified interface to the CloudConvert API.

[![NPM Badge](https://nodei.co/npm/cloudconverter.png)](https://npmjs.com/package/cloudconverter)

## Install

```sh
npm install cloudconverter
```

## Usage

```js
const cloudConverter = require("cloud-converter");

(async () => {
	await cloudConverter("input.png", "output.jpg", { apiKey: ... }); // Convert PNG to JPG
})();
```

## API

### cloudConverter(filename, output, options)

#### filename

Type: `string`

The input filename.

#### output

Type: `string`

The output filename.

#### options

Type: `object`

##### apiKey

Type: `string`

The CloudConvert API key.

##### sandbox

Type: `boolean`\
Default: `false`

Use sandbox mode.

### cloudConverter.stream(input, output, format, options)

#### input

Type: `ReadableStream`

The input stream.

#### output

Type: `WritableStream`

The output stream.

#### format

Type: `string`

The format to convert to.

#### options

Type: `object`

See [options](#options).

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