@jaak/playback-node

@jaak/playback-node

Polyfils the WebCrypto API for usage in node.js environments

⚠️ This repo is under active development and the API is likely to change without warning ⚠️

Installation

npm i @jaak/playback-node

Usage

First, create a Key instance with a file path to an app key. This information can be found on your application dashboard. Then instantiate a new Application instance with the Key instance.

import { Application, importKey, Key } from '@jaak/playback-node'

const keyfilePath = '/Absolute/File/Path/to/jaak-app-key.pem'

importKey(keyfilePath).then(appKey => {
  const playbackApp = new Application(appKey)
})

Contributing 🙋‍♀️

All proposed changes must start in an issue, following the guidelines provided in the issue template. Once the work has been carried out locally on an up-to-date working copy of master a pull request should be opened, following the guidelines provided in the pull request template.

Setup 🏗

These commands are for setting the environment up to contribute to the package.

First run an npm install:

npm install

Test 🃏

Prior to opening a pull request for your changes regression tests must be run. If your changes depend on fixture data please do not edit existing fixture data instead add new data.

npm test