The Worker interface of the Web Workers API represents a background task that can be created via script, which can send messages back to its creator. Creating a worker is done by calling the Worker("path/to/worker/script") constructor.

From MDN Web Docs: Worker API

This package contains type definitions which will set up the global environment for your TypeScript project to match the runtime environment of a Web Worker. The APIs inside @types/webworker are generated from the specifications for JavaScript.

To use @types/webworker you need to do two things:

1. Install the dependency: npm install @types/webworker --save-dev, yarn add @types/webworker --dev or pnpm add @types/webworker --dev.

2. Update your tsconfig.json to avoid clashing with the DOM APIs. There are two cases to consider depending on if you have lib defined in your tsconfig.json or not.

   1. Without "lib" - You will need to add "lib": []. The value you want to add inside your lib should correlate to your "target". For example if you had "target": "es2017", then you would add "lib": ["es2017"]
   2. With "lib" - You should remove "dom".

That's all.

This project does not respect semantic versioning as almost every change could potentially break a project, though we try to minimize removing types.

@types/webworker follow the specifications, so when they mark a function/object/API/type as deprecated or removed - that is respected.

You can read what changed in version {{version}} at {{release_href}}.