Socket
Socket
Sign inDemoInstall

worker-loader

Package Overview
Dependencies
Maintainers
8
Versions
34
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

worker-loader - npm Package Compare versions

Comparing version 1.0.0 to 1.1.0

dist/cjs.js
dist/Error.js
dist/index.js
dist/options.json
dist/workers/index.js
dist/workers/InlineWorker.js

12

CHANGELOG.md

@@ -5,4 +5,14 @@ # Change Log

<a name="1.1.0"></a>
# [1.1.0](https://github.com/webpack-contrib/worker-loader/compare/v1.0.0...v1.1.0) (2017-10-24)
### Features
* add `publicPath` support (`options.publicPath`) ([#31](https://github.com/webpack-contrib/worker-loader/issues/31)) ([96c6144](https://github.com/webpack-contrib/worker-loader/commit/96c6144))
<a name="1.0.0"></a>
# [1.0.0](https://github.com/webpack-contrib/worker-loader/compare/v0.8.0...v1.0.0) (2017-09-25)
## [1.0.0](https://github.com/webpack-contrib/worker-loader/compare/v0.8.0...v1.0.0) (2017-09-25)

@@ -9,0 +19,0 @@

82

package.json
{
"name": "worker-loader",
"version": "1.0.0",
"version": "1.1.0",
"author": "Tobias Koppers @sokra",
"description": "worker loader module for webpack",
"main": "dist/cjs.js",
"files": [
"dist"
],
"engines": {
"node": ">= 4.8 < 5.0.0 || >= 5.10"
},
"scripts": {
"test": "mocha",
"test": "jest",
"posttest": "eslint .",
"release": "standard-version"
"webpack-defaults": "webpack-defaults",
"start": "npm run build -- -w",
"appveyor:test": "npm run test",
"build": "cross-env NODE_ENV=production babel src -d dist --ignore 'src/**/*.test.js' --copy-files",
"clean": "del-cli dist",
"lint": "eslint --cache src test",
"lint-staged": "lint-staged",
"prebuild": "npm run clean",
"prepublish": "npm run build",
"release": "standard-version",
"security": "nsp check",
"test:watch": "jest --watch",
"test:coverage": "jest --collectCoverageFrom='src/**/*.js' --coverage",
"travis:lint": "npm run lint && npm run security",
"travis:test": "npm run test -- --runInBand",
"travis:coverage": "npm run test:coverage -- --runInBand"
},
"eslintConfig": {
"extends": "webpack",
"rules": {
"linebreak-style": 0,
"comma-dangle": [
"error",
{
"arrays": "always-multiline",
"objects": "always-multiline",
"imports": "always-multiline",
"exports": "always-multiline",
"functions": "never"
}
],
"no-underscore-dangle": 0,
"no-param-reassign": 0,
"prefer-destructuring": 0,
"strict": 0
}
},
"peerDependencies": {
"webpack": ">=0.9 || ^2.0.0 || ^3.0.0"
"webpack": "^2.0.0 || ^3.0.0"
},
"dependencies": {
"loader-utils": "^1.0.2",
"loader-utils": "^1.0.0",
"schema-utils": "^0.3.0"
},
"devDependencies": {
"del": "^2.2.2",
"eslint": "^3.16.0",
"babel-cli": "^6.0.0",
"babel-jest": "^21.0.0",
"babel-plugin-transform-object-rest-spread": "^6.0.0",
"babel-polyfill": "^6.0.0",
"babel-preset-env": "^1.0.0",
"cross-env": "^5.0.0",
"del": "^3.0.0",
"del-cli": "^1.0.0",
"eslint": "^4.0.0",
"eslint-config-webpack": "^1.0.0",
"eslint-plugin-import": "^2.2.0",
"mocha": "^3.2.0",
"standard-version": "^4.2.0",
"webpack": "^2.2.1"
"jest": "^21.0.0",
"lint-staged": "^4.0.0",
"nsp": "^2.6.0",
"pre-commit": "^1.0.0",
"standard-version": "^4.0.0",
"webpack": "^3.0.0",
"webpack-defaults": "^1.6.0"
},

@@ -51,3 +64,10 @@ "repository": {

},
"license": "MIT"
"license": "MIT",
"pre-commit": "lint-staged",
"lint-staged": {
"*.js": [
"eslint --fix",
"git add"
]
}
}

267

README.md
[![npm][npm]][npm-url]
[![node][node]][node-url]
[![deps][deps]][deps-url]
[![test][test]][test-url]
[![coverage][cover]][cover-url]
[![chat][chat]][chat-url]

@@ -8,8 +10,9 @@

<a href="https://github.com/webpack/webpack">
<img width="200" height="200" hspace="25" src="https://cdn.rawgit.com/webpack/media/e7485eb2/logo/icon.svg">
<img width="200" height="200" src="https://cdn.rawgit.com/webpack/media/e7485eb2/logo/icon.svg">
</a>
<h1>Worker Loader</h1>
<p>This loader registers the script as <a href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API">Web Worker</a>.<p>
<p>This loader registers the script as <a href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API">Web Worker</a><p>
</div>
<h2 align="center">Install</h2>

@@ -21,94 +24,218 @@

or
<h2 align="center"><a href="https://webpack.js.org/concepts/loaders">Usage</a></h2>
```bash
yarn add worker-loader --dev
### `Inlined`
**App.js**
```js
import Worker from 'worker-loader!./Worker.js';
```
<h2 align="center"><a href="https://webpack.js.org/concepts/loaders">Usage</a></h2>
### `Config`
Import the worker file:
**webpack.config.js**
```js
{
module: {
rules: [
{
test: /\.worker\.js$/,
use: { loader: 'worker-loader' }
}
]
}
}
```
``` javascript
// main.js
var MyWorker = require("worker-loader!./file.js");
**App.js**
```js
import Worker from './file.worker.js';
var worker = new MyWorker();
worker.postMessage({a: 1});
worker.onmessage = function(event) {...};
worker.addEventListener("message", function(event) {...});
const worker = new Worker();
worker.postMessage({ a: 1 });
worker.onmessage = function (event) {};
worker.addEventListener("message", function (event) {});
```
You can also inline the worker as a blob with the `inline` parameter:
``` javascript
var MyWorker = require("worker-loader?inline!./myWorker.js");
<h2 align="center">Options</h2>
|Name|Type|Default|Description|
|:--:|:--:|:-----:|:----------|
|[**`name`**](#name)|`{String}`|`[hash].worker.js`|Set a custom name for the output script|
|[**`inline`**](#inline)|`{Boolean}`|`false`|Inline the worker as a BLOB|
|[**`fallback`**](#fallback)|`{Boolean}`|`false`|Require a fallback for non-worker supporting environments|
|[**`publicPath`**](#publicPath)|`{String}`|`null`|Override the path from which worker scripts are downloaded|
### `name`
To set a custom name for the output script, use the `name` parameter. The name may contain the string `[hash]`, which will be replaced with a content dependent hash for caching purposes
*webpack.config.js**
```js
{
loader: 'worker-loader',
options: { name: 'WorkerName.[hash].js' }
}
```
Inline mode will also create chunks for browsers without supporting of inline workers,
to disable this behavior just set `fallback` parameter as `false`:
### `inline`
``` javascript
var MyWorker = require("worker-loader?inline&fallback=false!./myWorker.js");
You can also inline the worker as a BLOB with the `inline` parameter
**webpack.config.js**
```js
{
loader: 'worker-loader',
options: { inline: true }
}
```
To set a custom name for the output script, use the `name` parameter. The name may contain the string `[hash]`,
which will be replaced with a content-dependent hash for caching purposes. For example:
> ℹ️ Inline mode will also create chunks for browsers without support for inline workers, to disable this behavior just set `fallback` parameter as `false`
``` javascript
var MyWorker = require("worker-loader?name=outputWorkerName.[hash].js!./myWorker.js");
**webpack.config.js**
```js
{
loader: 'worker-loader'
options: { inline: true, fallback: false }
}
```
### `fallback`
The worker file can import dependencies just like any other file:
Require a fallback for non-worker supporting environments
``` javascript
// file.js
var _ = require('lodash')
**webpack.config.js**
```js
{
loader: 'worker-loader'
options: { fallback: false }
}
```
var o = {foo: 'foo'}
### `publicPath`
_.has(o, 'foo') // true
Overrides the path from which worker scripts are downloaded. If not specified, the same public path used for other
webpack assets is used
**webpack.config.js**
```js
{
loader: 'worker-loader'
options: { publicPath: '/scripts/workers/' }
}
```
<h2 align="center">Examples</h2>
The worker file can import dependencies just like any other file
**Worker.js**
```js
const _ = require('lodash')
const obj = { foo: 'foo' }
_.has(obj, 'foo')
// Post data to parent thread
self.postMessage({foo: 'foo'})
self.postMessage({ foo: 'foo' })
// Respond to message from parent thread
self.addEventListener('message', function(event){ console.log(event); });
self.addEventListener('message', (event) => console.log(event))
```
You can even use ES6 modules if you have the babel-loader configured:
### `Integrating with ES2015 Modules`
``` javascript
// file.js
> ℹ️ You can even use ES2015 Modules if you have the [`babel-loader`](https://github.com/babel/babel-loader) configured.
**Worker.js**
```js
import _ from 'lodash'
let o = {foo: 'foo'}
const obj = { foo: 'foo' }
_.has(o, 'foo') // true
_.has(obj, 'foo')
// Post data to parent thread
self.postMessage({foo: 'foo'})
self.postMessage({ foo: 'foo' })
// Respond to message from parent thread
self.addEventListener('message', (event) => { console.log(event); });
self.addEventListener('message', (event) => console.log(event))
```
### Integrating with TypeScript
### `Integrating with TypeScript`
To integrate with TypeScript, you will need to define a custom module for the exports of your worker. You will also need to cast the new worker as the `Worker` type:
To integrate with TypeScript, you will need to define a custom module for the exports of your worker
**typings/custom.d.ts**
```
```ts
declare module "worker-loader!*" {
const content: any;
export = content;
class WebpackWorker extends Worker {
constructor();
}
export = WebpackWorker;
}
```
**Worker.ts**
```ts
const ctx: Worker = self as any;
// Post data to parent thread
ctx.postMessage({ foo: "foo" });
// Respond to message from parent thread
ctx.addEventListener("message", (event) => console.log(event));
```
**App.ts**
```ts
import Worker = require("worker-loader!./Worker");
const worker = new Worker();
worker.postMessage({ a: 1 });
worker.onmessage = (event) => {};
worker.addEventListener("message", (event) => {});
```
import * as MyWorker from "worker-loader!../../worker";
const worker: Worker = new MyWorker();
### `Cross-Origin Policy`
[`WebWorkers`](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) are restricted by a [same-origin policy](https://en.wikipedia.org/wiki/Same-origin_policy), so if your `webpack` assets are not being served from the same origin as your application, their download may be blocked by your browser. This scenario can commonly occur if you are hosting your assets under a CDN domain. Even downloads from the `webpack-dev-server` could be blocked. There are two workarounds
Firstly, you can inline the worker as a blob instead of downloading it as an external script via the [`inline`](#inline) parameter
**App.js**
```js
import Worker from './file.worker.js';
```
**webpack.config.js**
```js
{
loader: 'worker-loader'
options: { inline: true }
}
```
Secondly, you may override the base download URL for your worker script via the [`publicPath`](#publicpath) option
**App.js**
```js
// This will cause the worker to be downloaded from `/workers/file.worker.js`
import Worker from './file.worker.js';
```
**webpack.config.js**
```js
{
loader: 'worker-loader'
options: { publicPath: '/workers/' }
}
```
<h2 align="center">Maintainers</h2>

@@ -120,22 +247,36 @@

<td align="center">
<a href="https://github.com/sokra">
<img width="150" height="150" src="https://github.com/sokra.png?s=150">
<a href="https://github.com/TrySound">
<img width="150" height="150" src="https://avatars3.githubusercontent.com/u/5635476?v=3&s=150">
</a>
<br />
<a href="https://github.com/sokra">Tobias Koppers</a>
<a href="https://github.com/TrySound">Bogdan Chadkin</a>
</td>
<td align="center">
<a href="https://github.com/bebraw">
<img width="150" height="150" src="https://github.com/bebraw.png?v=3&s=150">
</br>
Juho Vepsäläinen
</a>
</td>
<td align="center">
<a href="https://github.com/d3viant0ne">
<img width="150" height="150" src="https://avatars2.githubusercontent.com/u/8420490?v=3&s=150">
<img width="150" height="150" src="https://github.com/d3viant0ne.png?v=3&s=150">
</br>
Joshua Wiens
</a>
<br />
<a href="https://github.com/d3viant0ne">Joshua Wiens</a>
</td>
<td align="center">
<a href="https://github.com/TrySound">
<img width="150" height="150" src="https://avatars3.githubusercontent.com/u/5635476?v=3&s=150">
<a href="https://github.com/michael-ciniawsky">
<img width="150" height="150" src="https://github.com/michael-ciniawsky.png?v=3&s=150">
</br>
Michael Ciniawsky
</a>
<br />
<a href="https://github.com/TrySound">Bogdan Chadkin</a>
</td>
<td align="center">
<a href="https://github.com/evilebottnawi">
<img width="150" height="150" src="https://github.com/evilebottnawi.png?v=3&s=150">
</br>
Alexander Krasnoyarov
</a>
</td>
</tr>

@@ -149,9 +290,15 @@ <tbody>

[node]: https://img.shields.io/node/v/cache-loader.svg
[node-url]: https://nodejs.org
[deps]: https://david-dm.org/webpack-contrib/worker-loader.svg
[deps-url]: https://david-dm.org/webpack-contrib/worker-loader
[test]: http://img.shields.io/travis/webpack-contrib/worker-loader.svg
[test-url]: https://travis-ci.org/webpack-contrib/worker-loader
[cover]: https://codecov.io/gh/webpack-contrib/cache-loader/branch/master/graph/badge.svg
[cover-url]: https://codecov.io/gh/webpack-contrib/cache-loader
[chat]: https://img.shields.io/badge/gitter-webpack%2Fwebpack-brightgreen.svg
[chat-url]: https://gitter.im/webpack/webpack
[test]: http://img.shields.io/travis/webpack-contrib/worker-loader.svg
[test-url]: https://travis-ci.org/webpack-contrib/worker-loader
.eslintignore
.npmignore
.travis.yml
createInlineWorker.js
index.js
options.json
test/fixtures/inline-fallbacks/entry.js
test/fixtures/inline-fallbacks/w1.js
test/fixtures/inline-fallbacks/w2.js
test/fixtures/inline-options/entry.js
test/fixtures/inline-options/w1.js
test/fixtures/inline-options/w2.js
test/fixtures/inline-query/entry.js
test/fixtures/inline-query/worker.js
test/fixtures/name-options/entry.js
test/fixtures/name-options/w1.js
test/fixtures/name-options/w2.js
test/fixtures/name-query/entry.js
test/fixtures/name-query/worker.js
test/fixtures/no-fallbacks/entry.js
test/fixtures/no-fallbacks/w1.js
test/fixtures/no-fallbacks/w2.js
test/fixtures/nodejs-core-modules/entry.js
test/fixtures/nodejs-core-modules/worker.js
test/fixtures/worker/entry.js
test/fixtures/worker/worker.js
test/index.js
yarn.lock
LICENSE

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc