# @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