# ae-read-curves

> Read After Effects curves exported by ae-export-curves

Latest version **0.0.2** (published 2018-03-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install ae-read-curves
pnpm add ae-read-curves
yarn add ae-read-curves
bun add ae-read-curves
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2018-03-11 |
| First published | 2018-03-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 38.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | pqml |
| Maintainers | pqml |
| Keywords | after effects, ae, curves, curve, easing |

## Links

- npm: https://www.npmjs.com/package/ae-read-curves
- Repository: https://github.com/pqml/ae-read-curves
- Homepage: https://github.com/pqml/ae-read-curves#readme
- Issues: https://github.com/pqml/ae-read-curves/issues
- npm.io page: https://npm.io/package/ae-read-curves

## Dependencies (1)

- [bezier-easing](https://npm.io/package/bezier-easing.md) ^2.0.3

## Recent versions

- 0.0.2 (latest) — 2018-03-11
- 0.0.1 — 2018-03-11

## README

<h1 align="center">ae-read-curves</h1>
<h3 align="center">Read After Effects curves exported by <a href="https://github.com/pqml/ae-export-curves">ae-export-curves</a></h3>

<br><br><br>

## Example
Example on [https://pqml.github.io/ae-read-curves](https://pqml.github.io/ae-read-curves)

<br><br>

## Features
- Read curves exported by [ae-export-curves](https://github.com/pqml/ae-export-curves)
- Get property values at a precise time, with the `seek()` function
- Tiny module, < 1ko gziped

<br><br>

## Module Installation & Usage

##### Installation from npm
```sh
# using npm
$ npm install --save ae-read-curves

# or using yarn
$ yarn add ae-read-curves
```

##### Usage with a module bundler
```js
// using ES6 module
import readCurves from 'ae-read-curves'

// using CommonJS module
const readCurves = require('ae-read-curves')

const comp = readCurves(json)

console.log(comp.duration) // get duration of the composition
console.log(comp.width) // get width of the composition
console.log(comp.height) // get height of the composition

comp.seek(0.5) // go to the middle of the composition timeline
console.log(comp.values.translateX) // get translateX property value at 0.5 progress
```

##### Usage from a browser

```html
<script src="https://unpkg.com/ae-read-curves"></script>
<script>
  var comp = window.AEReadCurves(json)
  comp.seek(0.1)
  console.log(comp.values.translateX)
</script>
```

<br><br>

## Development commands

- `npm install` - Install all npm dependencies
- `npm run start` - Start the dev server with livereload on the example folder
- `npm run build` - Bundle your library in CJS / UMD / ESM
- `npm run deploy` - Deploy your example folder on a gh-page branch
- `npm run test` - Lint your js inside the src folder

<br><br>

## License
MIT.

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