Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vardius/peer-cdn
Lightweight library providing peer to peer CDN functionality
https://github.com/vardius/peer-cdn
cache cdn peer peer-cdn
Last synced: 2 months ago
JSON representation
Lightweight library providing peer to peer CDN functionality
- Host: GitHub
- URL: https://github.com/vardius/peer-cdn
- Owner: vardius
- License: mit
- Created: 2017-06-12T01:23:37.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T03:47:41.000Z (almost 2 years ago)
- Last Synced: 2024-10-14T06:09:01.749Z (3 months ago)
- Topics: cache, cdn, peer, peer-cdn
- Language: JavaScript
- Homepage: https://rafallorenz.com/peer-cdn
- Size: 30.4 MB
- Stars: 68
- Watchers: 5
- Forks: 12
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# peer-cdn
[](https://travis-ci.org/vardius/peer-cdn)
[](https://codecov.io/gh/vardius/peer-cdn)
[](https://www.npmjs.com/package/peer-cdn)
[](https://www.npmjs.com/package/peer-cdn)
[](LICENSE.md)
Lightweight library providing peer to peer CDN functionality
π ABOUT
==================================================
Contributors:
* [RafaΕ Lorenz](https://rafallorenz.com)
Want to contribute ? Feel free to send pull requests!
Have problems, bugs, feature ideas?
We are using the github [issue tracker](https://github.com/vardius/peer-cdn/issues) to manage them.
## π Documentation
For **documentation** (_including examples_), **visit [rafallorenz.com/peer-cdn](https://rafallorenz.com/peer-cdn)**
π HOW TO USE
==================================================
## Installation
```bash
$ npm install peer-cdn
```
## Basic example
### main.js
```js
"use strict";
import { PeerPlugin } from "peer-cdn";
if ("serviceWorker" in navigator) {
// since sw does not support WebRTC yet
// this is workaround to use it
// we use PeerPlugin on client side
const peerPlugin = new PeerPlugin({
cacheName: CachePlugin.peerFetch + 1,
timeoutAfter: 3000,
servers: {
iceServers: [
{
url: "stun:74.125.142.127:19302",
},
],
},
constraints: {
ordered: true,
},
});
// Set up a listener for messages posted from the service worker.
// The service worker is set to post a message to specific client only
// so you should see this message event fire once.
// You can force it to fire again by visiting this page in an Incognito window.
navigator.serviceWorker.addEventListener("message", function (event) {
const request = new Request(event.data.url);
// mock sw event wrapping request with object
const middleware = peerPlugin.getMiddleware({ request });
// run get method of a created middleware
middleware
.get()
.then(function (response) {
// return response to a service worker
event.ports[0].postMessage(response);
})
.catch(function (error) {
// return response to a service worker
event.ports[0].postMessage(null);
});
});
navigator.serviceWorker
.register("sw.js")
.then(function (registration) {
// Registration was successful
console.log(
"ServiceWorker registration successful with scope: ",
registration.scope
);
})
.catch(function (error) {
console.error("Service Worker Error", error);
});
}
```
### sw.js
```js
// import peer-cdn into service worker
self.importScripts("https://github.com/vardius/peer-cdn/blob/v1.0.5-beta/dist/index.js");
const { CachePlugin, DelegatePlugin, NetworkPlugin, strategies: { ordered }} = PeerCDN;
const cachePlugin = new CachePlugin({ version: 1 });
// since sw does not support WebRTC yet we use PeerPlugin on client side
// and we delegate request to it with DelegatePlugin
const delegatePlugin = new DelegatePlugin({ timeoutAfter: 5000 });
const networkPlugin = new NetworkPlugin();
const cdn = new PeerCDN();
cdn.GET("/css/main.css", ordered,
cachePlugin.getMiddleware,
delegatePlugin.getMiddleware,
networkPlugin.getMiddleware
);
// We need to register service worker events
// cdn.register() will add listeners for install, activate and fetch
// gaining required control
cdn.register();
```
π [License](LICENSE.md)
-------
This package is released under the MIT license. See the complete license in the package