Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/darrencocco/moodle-local_webworkers
Web Worker support for Moodle
https://github.com/darrencocco/moodle-local_webworkers
moodle requirejs webworkers
Last synced: about 6 hours ago
JSON representation
Web Worker support for Moodle
- Host: GitHub
- URL: https://github.com/darrencocco/moodle-local_webworkers
- Owner: darrencocco
- License: lgpl-3.0
- Created: 2019-07-01T04:01:57.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-05T02:51:02.000Z (3 months ago)
- Last Synced: 2024-11-05T03:28:31.180Z (3 months ago)
- Topics: moodle, requirejs, webworkers
- Language: JavaScript
- Homepage:
- Size: 4 MB
- Stars: 0
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
### Moodle Web Worker support
Adds a way of using [Web Workers][1] inside of YUI and AMD code
Web workers give you the ability to run JavaScript code in a thread
that will not interrupt the main thread that all the DOM interactions
etc run on.
#### TODO
* Add caching to worker.php (done)
* Test and add support for Service Workers
* Add Shared Workers tests (done)
#### Usage examples
For YUI use:
```JavaScript
var exampleDedicatedWorker;
M.util.js_pending("YUI/yourScriptName/exampleDedicatedWorker");
require(["local_webworkers/web_worker"], function(webWorker) {
exampleDedicatedWorker = new Worker(webWorker.toURI("{plugin}/{component}"));
M.util.js_complete("YUI/yourScriptName/exampleDedicatedWorker");
});
exampleDedicatedWorker.onmessage = function(event) {
console.log(event.data);
};
```
For AMD use:
```JavaScript
define(['local_webworkers/web_worker'], function({webWorker}) {
let dedicatedWorker = new Worker(webWorker.toURI('{plugin}/{component}'));
dedicatedWorker.addEventListener('message', function(event) {
console.log(event.data);
});
dedicatedWorker.postMessage('');
let sharedWorker = new SharedWorker(webWorker.toURI('{plugin}/{component}'));
sharedWorker.port.addEventListener('message', function(event) {
console.log(event.data);
});
sharedWorker.port.start();
sharedWorker.port.postMessage('');
});
```
Implement a Dedicated Worker:
```JavaScript
define(['local_webworkers/web_worker'], function(webWorker) {
return {
init: function() {
self.addEventListener('message', function(e) {
self.postMessage({
type: 'TextMessage',
contentsString: e.data.contentsString,
});
});
webWorker.workerSetupComplete();
}
};
});
```
Implement a Shared Worker:
```JavaScript
define(['local_webworkers/web_worker'], function(webWorker) {
return {
init: function() {
let portMap = [];
/**
* Generates a sequential set of numbers for the
* lifetime of the worker.
* @returns {Generator}
*/
function* generatePortNumber() {
const start = 0;
const end = Infinity;
const step = 1;
for (let i = start; i < end; i += step) {
yield i;
}
}
let portNumber = generatePortNumber();
self.addEventListener("connect", (e) => {
let clientId = portNumber.next().value;
portMap[clientId] = e.ports[0];
e.ports[0].addEventListener("message", handleClientMessage(clientId));
e.ports[0].start();
});
let handleMessage = (clientId, e) => {
portMap.forEach(function (port, portId) {
if (clientId != portId) {
port.postMessage({
type: 'TextMessage',
clientId: clientId,
contentsString: e.data.contentsString,
});
} else {
port.postMessage({
type: 'Pong',
clientId: clientId,
contentsString: e.data.contentsString,
});
}
});
};
let handleClientMessage = (clientId) => {
return (e) => {
return handleMessage(clientId, e);
};
};
webWorker.workerSetupComplete();
}
};
});
```
[1]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers