import-from-worker

    1.0.1 • Public • Published

    importFromWorker()

    It’s like import(), but runs the module in a worker.

    This library is a love-child of @_developit and @dassurma.

    Total size: 1.7K brotli’d (including Comlink).

    Requires modules in workers, which are currently only implemented in Chrome!

    Usage

    // service.js
    export function add(a, b) {
      return a + b;
    }
     
    export function multiply(a, b) {
      return a * b;
    }
    // main.js
    import importFromWorker from "import-from-worker";
     
    const { add, multiply } = await importFromWorker("./service.js");
    console.log(await add(40, 2));
    // ...

    You can also use importFromWorker() from a CORS-enabled CDN like JSDelivr or unpkg:

    import importFromWorker from "https://cdn.jsdelivr.net/npm/import-from-worker@latest/dist/import-from-worker.js";

    You can remix this glitch, if you like.

    Q&A

    How does it work?

    The library injects itself as the worker file and then uses dynamic import() to load the module. The resulting module is then exposed to the worker’s parent using Comlink. All guidance about callbacks and transferables from Comlink applies to this library as well. For adjustments, the library re-exports Comlink:

    import importFromWorker, { Comlink } from "import-from-worker";

    Can I get a handle to the underlying worker?

    Why yes you can! The module exports a workerSymbol that can be used thusly:

    import importFromWorker, { workerSymbol } from "import-from-worker";
     
    const module = await importFromWorker("./service.js");
    const worker = module[workerSymbol];
    // You could also use destructuring:
    // const {[workerSymbol]: worker, add, subtract} = await importFromWorker("./service.js");
     
    // Use the worker instance directly
    worker.terminate();

    What about browsers without module support in workers?

    I tried to make the library work in those environments. It’s possible, but it gets messy. I welcome PRs (and preferably a preceding issue to discuss the design) on this problem!

    How do I feature-detect module support in workers?

    The snippet that’s somewhat endorsed by the WHATWG is the following:

    let supportsModuleWorker = false;
    const workerURL = URL.createObjectURL(new Blob([""]));
    const options = {
      get type() {
        supportsModuleWorker = true;
      }
    };
    new Worker(workerURL, options).terminate();
    URL.revokeObjectURL(workerURL);

    License Apache-2.0

    Keywords

    none

    Install

    npm i import-from-worker

    DownloadsWeekly Downloads

    3

    Version

    1.0.1

    License

    Apache-2.0

    Unpacked Size

    30 kB

    Total Files

    15

    Last publish

    Collaborators

    • surma