Skip to content

Commit 11b7c1d

Browse files
committed
fix(Readme): Update readme to better reflect that the old style of worker construction is deprecated
1 parent 49e16aa commit 11b7c1d

File tree

4 files changed

+14
-20
lines changed

4 files changed

+14
-20
lines changed

README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -62,36 +62,33 @@ yarn add observable-webworker
6262

6363
💡 Take note! The webworker construction syntax differs for different version of webpack:
6464

65-
#### Webpack < 5
65+
#### Webpack < 5 (deprecated)
6666

6767
```ts
68-
// src/readme/hello.ts
68+
// src/readme/hello-legacy-webpack.ts
6969

7070
import { fromWorker } from 'observable-webworker';
7171
import { of } from 'rxjs';
7272

7373
const input$ = of('Hello from main thread');
7474

75-
fromWorker<string, string>(
76-
() => new Worker(new URL('./hello.worker', import.meta.url), { type: 'module' }),
77-
input$,
78-
).subscribe(message => {
75+
fromWorker<string, string>(() => new Worker('./hello.worker', { type: 'module' }), input$).subscribe(message => {
7976
console.log(message); // Outputs 'Hello from webworker'
8077
});
8178

8279
```
8380
#### Webpack 5
8481

8582
```ts
86-
// src/readme/hello-webpack-5.ts#L2-L12
83+
// src/readme/hello.ts#L2-L12
8784

8885
import { fromWorker } from 'observable-webworker';
8986
import { of } from 'rxjs';
9087

9188
const input$ = of('Hello from main thread');
9289

9390
fromWorker<string, string>(
94-
() => new Worker(new URL('./app.worker', import.meta.url), { type: 'module' }),
91+
() => new Worker(new URL('./hello.worker', import.meta.url), { type: 'module' }),
9592
input$,
9693
).subscribe(message => {
9794
console.log(message); // Outputs 'Hello from webworker'

src/readme/hello-legacy-webpack.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
import { fromWorker } from 'observable-webworker';
2+
import { of } from 'rxjs';
3+
4+
const input$ = of('Hello from main thread');
5+
6+
fromWorker<string, string>(() => new Worker('./hello.worker', { type: 'module' }), input$).subscribe(message => {
7+
console.log(message); // Outputs 'Hello from webworker'
8+
});

src/readme/hello-webpack-5.ts

Lines changed: 0 additions & 12 deletions
This file was deleted.

src/readme/hello.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
// @ts-nocheck - @todo remove typechecking prevention once the typescript config supports it
12
import { fromWorker } from 'observable-webworker';
23
import { of } from 'rxjs';
34

0 commit comments

Comments
 (0)