@quilted/events - npm Package Compare versions

Comparing version 0.0.0-preview-20240731033135 to 0.0.0-preview-20240816174814

build/typescript/abort/NestedAbortController.d.ts

@@ -20,4 +20,4 @@ /**
 export declare class NestedAbortController extends AbortController {
-    constructor(...parents: AbortSignal[]);
+    constructor(...parents: Pick<AbortSignal, 'aborted' | 'reason' | 'addEventListener'>[]);
 }
 //# sourceMappingURL=NestedAbortController.d.ts.map

CHANGELOG.md

 # @quilted/events
 
-## 0.0.0-preview-20240731033135
+## 0.0.0-preview-20240816174814
 
-### Minor Changes
+### Patch Changes
 
-- Add `EventTargetSignal` class for converting an `EventTarget` into a Preact signal
+- Changed Preact thread utilities to be class-based instead of being a collection of utility functions.
 
+  Previously, you used `createThreadSignal()` to serialize a Preact signal to pass over a thread, and `acceptThreadSignal()` to turn it into a "live" signal. With the new API, you will do the same steps, but with `ThreadSignal.serialize()` and `new ThreadSignal()`:
+
+  ```js
+  import {signal, computed} from '@preact/signals-core';
+  import {ThreadWebWorker, ThreadSignal} from '@quilted/threads';
+
+  // Old API:
+  const result = signal(32);
+  const serializedSignal = createThreadSignal(result);
+  await thread.imports.calculateResult(serializedSignal);
+
+  // New API:
+  const result = signal(32);
+  const serializedSignal = ThreadSignal.serialize(result);
+  await thread.imports.calculateResult(serializedSignal);
+
+  // In the target thread:
+
+  // Old API:
+  function calculateResult(resultThreadSignal) {
+    const result = acceptThreadSignal(resultThreadSignal);
+    const computedSignal = computed(
+      () => `Result from thread: ${result.value}`,
+    );
+    // ...
+  }
+
+  // New API:
+  function calculateResult(resultThreadSignal) {
+    const result = new ThreadSignal(resultThreadSignal);
+    const computedSignal = computed(
+      () => `Result from thread: ${result.value}`,
+    );
+    // ...
+  }
+  ```
+
+## 2.1.1
+
+### Patch Changes
+
+- [#818](https://github.com/lemonmade/quilt/pull/818) [`8669216`](https://github.com/lemonmade/quilt/commit/8669216a28c6d8b5b62d4f297ece8f44b8f9f3ae) Thanks [@lemonmade](https://github.com/lemonmade)! - Changed Preact thread utilities to be class-based instead of being a collection of utility functions.
+
+  Previously, you used `createThreadSignal()` to serialize a Preact signal to pass over a thread, and `acceptThreadSignal()` to turn it into a "live" signal. With the new API, you will do the same steps, but with `ThreadSignal.serialize()` and `new ThreadSignal()`:
+
+  ```js
+  import {signal, computed} from '@preact/signals-core';
+  import {ThreadWebWorker, ThreadSignal} from '@quilted/threads';
+
+  // Old API:
+  const result = signal(32);
+  const serializedSignal = createThreadSignal(result);
+  await thread.imports.calculateResult(serializedSignal);
+
+  // New API:
+  const result = signal(32);
+  const serializedSignal = ThreadSignal.serialize(result);
+  await thread.imports.calculateResult(serializedSignal);
+
+  // In the target thread:
+
+  // Old API:
+  function calculateResult(resultThreadSignal) {
+    const result = acceptThreadSignal(resultThreadSignal);
+    const computedSignal = computed(
+      () => `Result from thread: ${result.value}`,
+    );
+    // ...
+  }
+
+  // New API:
+  function calculateResult(resultThreadSignal) {
+    const result = new ThreadSignal(resultThreadSignal);
+    const computedSignal = computed(
+      () => `Result from thread: ${result.value}`,
+    );
+    // ...
+  }
+  ```
+
 ## 2.1.0
@@ -10,0 +90,0 @@

package.json

@@ -5,3 +5,3 @@ {
   "type": "module",
-  "version": "0.0.0-preview-20240731033135",
+  "version": "0.0.0-preview-20240816174814",
   "license": "MIT",
@@ -8,0 +8,0 @@ "engines": {

source/abort/NestedAbortController.ts

@@ -20,3 +20,5 @@ /**
 export class NestedAbortController extends AbortController {
-  constructor(...parents: AbortSignal[]) {
+  constructor(
+    ...parents: Pick<AbortSignal, 'aborted' | 'reason' | 'addEventListener'>[]
+  ) {
     super();
@@ -23,0 +25,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

162629

increased by1.85%

Lines of code

2227

increased by0.09%

No dependency changes