# @modfy/core

> Core Package for interfacing with api.modfy.video

Latest version **0.0.8-b** (published 2021-05-31) · SEE LICENSE IN Modfy-Core-License.pdf license · 0 weekly downloads

## Install

```sh
npm install @modfy/core
pnpm add @modfy/core
yarn add @modfy/core
bun add @modfy/core
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.8-b |
| Published | 2021-05-31 |
| First published | 2021-03-09 |
| Weekly downloads | 0 |
| License | SEE LICENSE IN Modfy-Core-License.pdf |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 499 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| Author | Modfy Inc |
| Maintainers | modfy |
| Keywords | video, api, wasm |

## Links

- npm: https://www.npmjs.com/package/@modfy/core
- Homepage: https://api.modfy.video
- npm.io page: https://npm.io/package/@modfy/core

## Dependencies (7)

- [temp](https://npm.io/package/temp.md) ^0.9.4
- [axios](https://npm.io/package/axios.md) ^0.21.1
- [form-data](https://npm.io/package/form-data.md) ^4.0.0
- [@bugsnag/js](https://npm.io/package/@bugsnag/js.md) ^7.8.0
- [@modfy/utils](https://npm.io/package/@modfy/utils.md) 0.0.2
- [mixpanel-browser](https://npm.io/package/mixpanel-browser.md) ^2.41.0
- [@modfy/interfaces](https://npm.io/package/@modfy/interfaces.md) 0.0.10-b

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.0.8-b (latest) — 2021-05-31
- 0.0.8-a — 2021-05-31
- 0.0.8 — 2021-05-29
- 0.0.7 — 2021-05-07
- 0.0.6 — 2021-04-11
- 0.0.5-a — 2021-03-25
- 0.0.4-b — 2021-03-17
- 0.0.3-c — 2021-03-15
- 0.0.3-b — 2021-03-11
- 0.0.3 — 2021-03-10
- 0.0.2 — 2021-03-09
- 0.0.1 — 2021-03-09

## README

# @modfy/core

This is the core package for the modfy api library

Full documenation [docs.modfy.video](https://docs.modfy.video/)

Currently _invite_ only, reach out to hello@modfy.video

## Install

```shell
yarn add @modfy/core

# Using Npm

npm install @modfy/core
```

## Auth

You can get your tokens at https://api.modfy.video/dashboard

```typescript
import Modfy from '@modfy/core'

const modfy = new Modfy({
  token: '',
  secretToken: 'sk*test*',
  clientSide: false
  // Optional value if you plan to use client side rendering. (Defaults to false)
})
```

## Operations

### General Operations

```typescript
const processedFile = modfy.operations(inputFiles, type, ...args)
```

### Compress

```typescript
const compressedFiles = modfy.compress(
  ['./input.mp4'],
  /* Files
    - Three types of files are accepted
    - 1. HTML File Object, you can pass in an File Object directly in your browser
    - 2. Object containing {name : string, buffer : Buffer, mineType? : string}
    - 3. String of File Path (Only supported in Node)
    */

  'client', // Type of processing, can choose from client or server
  10 // Compression value
)
// Function returns a Promise<Uint8Array>
```

## Reference

https://docs.modfy.video/reference/index.html

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