Question 1

How to pass a callback function to a WebWorker using Comlink?

Accepted Answer

Wrap the callback with Comlink.proxy() to allow cross-thread invocation, as shown in the callback example. This is necessary because functions aren't structured cloneable or transferable by default.

Question 2

Comlink vs manual postMessage: which is better for performance?

Accepted Answer

Comlink simplifies development but adds a thin RPC layer, so manual postMessage might be faster for high-frequency, low-latency messaging. For most apps, Comlink's ease of use outweighs the minor overhead.

Question 3

Can Comlink handle large data transfers without copying?

Accepted Answer

Yes, use Comlink.transfer() with transferable objects like ArrayBuffer to move data efficiently. The README shows an example with Uint8Array to avoid structured cloning overhead.

Question 4

How to set up Comlink with SharedWorkers?

Accepted Answer

Expose objects in the worker's onconnect callback and wrap the SharedWorker's port property, as detailed in the SharedWorker example. This requires extra steps compared to regular WebWorkers.

Question 5

Is Comlink good for Node.js worker threads?

Accepted Answer

Yes, Comlink supports Node.js worker_threads, with an example in the docs folder. It provides the same RPC abstraction, making multi-threading in Node.js more accessible.

Question 6

What happens if I don't release a Comlink proxy?

Accepted Answer

Proxies can cause memory leaks if not detached; call [Comlink.releaseProxy]() manually or rely on garbage collection with WeakRef support. The API section explains this to manage resources.

comlink

What is comlink?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions