Skip to content
This repository was archived by the owner on Jan 26, 2019. It is now read-only.
This repository was archived by the owner on Jan 26, 2019. It is now read-only.

Support Web Workers #308

@doxxx

Description

@doxxx

Upstream is working on adding Web Worker support: facebook/create-react-app#3660. It would be nice to support that as well here, with the necessary type declarations for Web Workers.

Currently, if I eject and modify my Webpack config to use worker-loader, I can only use a Typescript-based Web Worker by defining a custom .d.ts file with a limited set of the APIs available in Web Workers (e.g. postMessage). If I try to enable the webworker lib in tsconfig.json, I get type declaration conflicts with the dom library, which is to be expected. Perhaps a tsconfig.webworkers.json is needed that is only applied to Web Worker .ts files?

What I have working so far:

  1. yarn run eject
  2. Add worker-loader to dev dependencies.
  3. Modify webpack.config.dev.js and webpackage.config.prod.js to include the following in the module rules:
{
  test: /\.worker\.js$/,
  use: { loader: 'worker-loader' }
}
  1. Create a worker-loader.d.ts custom typings file:
declare module 'worker-loader!*' {
  class WebpackWorker extends Worker {
    constructor();
  }

  // noinspection JSUnusedGlobalSymbols
  export default WebpackWorker;
}

// noinspection TsLint
declare function postMessage(message: any, transfer?: any[]): void;

I can now define a test.worker.ts like so:

import { someStuff } from './another/typescript/file';

// Post data to parent thread
postMessage({ foo: 'foo' });

// Respond to message from parent thread
addEventListener('message', event => console.log('message from main thread', event));

And create it in the app's index.tsx like so:

import TestWorker from 'worker-loader!./test.worker';

const worker = new TestWorker();

worker.postMessage({ a: 1 });
worker.onmessage = event => {
  console.log('onmessage from worker', event);
};

worker.addEventListener('message', event => {
  console.log('message event from worker', event);
});

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      pFad - Phonifier reborn

      Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

      Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


      Alternative Proxies:

      Alternative Proxy

      pFad Proxy

      pFad v3 Proxy

      pFad v4 Proxy