Package

purescript-workers

Repository
truqu/purescript-workers
License
MIT
Uploaded by
KtorZ

This package offers bindings of the Web Workers (Dedicated, Shared & Service) APIs.

DISCLAIMER This package is still highly experimental. Do not hesitate to fill in an issue if you encounter any trouble. Any feedback is welcome!

Overview

TODO

How To: Run Examples

The examples contains few examples of the Service Worker Cookbook translated to PureScript. This is still work-in-progress and still relies on the sources provided by Mozilla included as a submodule.

Therefore,

commands are written as if you were running them from the root of the repository

  1. Make sure the submodule is installed
git submodule init
git submodule update
  1. Install dependencies of the Service Worker Cookbook
cd examples/serviceworker-cookbook
npm i
  1. Install dependencies of an example
cd examples/cache-and-update
npm i
  1. Compile the example's PureScript sources
cd examples/cache-and-update
npm run build
  1. Start the Service Worker Cookbook server
cd examples/serviceworker-cookbook
gulp start-server

If the server doesn't start because you don't have any GCM API Key, you can simply remove all the push-* examples from there and try again.

  1. Visit your localhost on port 3003
firefox http://localhost:3003/strategy-cache-and-update_demo.html

Changelog

Roadmap

v2.1.0

  • Implement Fetch, Request & Response API

  • Basic example for service workers from mozilla/serviceworkers-cookbook

v2.0.0

  • Internal implementation rework

  • Supports for Service Workers

  • Supports for Cache & CacheStorage

v1.0.0

  • Supports for the Dedicated Workers
  • Supports for the Shared Workers
  • Supports for the Application Cache

Documentation

Module documentation is published on Pursuit.

Some additionals links: