PakhshKit JS Offline Manager is a javascript library that gives the ability to store and manage content locally. The offline manager provides an API to control the entire download process (download, resume, pause, cancel) and to delete stored content. The offline manager supports storing both clear and protected content.
PakhshKit JS Offline Manager is written in ECMAScript6, analyzed statically using Flow, and transpiled in ECMAScript5 using Babel.
First, clone and run yarn to install dependencies:
git clone https://github.com/vidiun/pakhshkit-js-offline-manager.git
cd pakhshkit-js-offline-manager
yarn install
Next, build the player:
yarn run build
Refer to this documention for more information:
Tests can be run locally via Karma, which will run on Chrome, Firefox and Safari browsers.
yarn run test
You can test individual browsers:
yarn run test:chrome
yarn run test:firefox
yarn run test:safari
We use ESLint recommended set with some additions for enforcing Flow types and other rules.
See ESLint config for complete configuration.
We also use .editorconfig to maintain consistent coding styles and settings; please make sure you comply with the styling listed there.
| | IE | Edge| Firefox| Chrome| Safari | Safari IOS| Firefox/Chrome IOS| Chrome for Android| |--|--| --|--|--|--|--|--|--|--|--| | Clear Content Download | +* | +* |+|+|+|+|+|+|| | Protected Content Download | - | - |+|+|+|-|-|+|| |Background fetch download (under development)|-|-|-|-|-|-|-|-|-|-|+|
(+) Tested (+*) Should work, not tested on this platform
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
This project is licensed under the AGPL-3.0 License - see the LICENSE.md file for details