我發(fā)布了一個名為sync-actions 的庫，它允許異步進(jìn)程在 JavaScript/TypeScript 中同步執(zhí)行。特別是在 TypeScript 中，您可以以類型安全的方式調(diào)用定義的函數(shù)。它適用于您想要在您不希望（或不能）標(biāo)記為異步的函數(shù)中執(zhí)行異步進(jìn)程的情況。

特征

• 利用 Node.jsworker_threads
  • 異步進(jìn)程在子線程中執(zhí)行，主線程同步等待其完成。
• 類型安全的函數(shù)調(diào)用
  • 在 TypeScript 中，您可以利用已定義函數(shù)的類型信息。
• 作為原生 ESM 發(fā)布
  • 由于不支持 CommonJS，它變得簡單。

存儲庫

https://github.com/koyopro/sync-actions

用法

安裝

它作為 npm 包發(fā)布，因此請使用 npm install 或類似的方式安裝它。

npm install sync-actions

基本用法

通過將返回Promise對象的異步函數(shù)傳遞給defineSyncWorker()，您可以定義接口并使用launch()啟動工作線程。假設(shè)定義工作程序的文件是與其他處理文件分開創(chuàng)建的。

// worker.js
import { defineSyncWorker } from "sync-actions";

export const { actions, worker } = defineSyncWorker(import.meta.filename, {
  ping: async () => {
    // Execute asynchronous process,
    await new Promise((resolve) => setTimeout(resolve, 1000));
    // Return the result as a return value
    return "pong";
  }
}).launch();

// main.js
import { actions, worker } from "./worker.js";

// You can execute asynchronous functions synchronously
console.log(actions.ping()); // => "pong" is output after 1 second

worker.terminate();

類型安全的函數(shù)調(diào)用

在 TypeScript 中，您可以以類型安全的方式調(diào)用使用 DefineSyncWorker 定義的函數(shù)。

// worker.ts
import { defineSyncWorker } from "sync-actions";

export const { actions, worker } = defineSyncWorker(import.meta.filename, {
  // By specifying the types of arguments and return values, type-safe calls are possible
  add: async (a: number, b: number): Promise<number> => {
    return a + b;
  }
}).launch();

// main.ts
import { actions, worker } from "./worker.js";

// Type-safe call
actions.add(1, 2); // => 3 (number)

// @ts-expect-error
actions.add("1", 2);
// => Argument of type 'string' is not assignable to parameter of type 'number'

worker.terminate();

背景

到目前為止的內(nèi)容與README相同，所以我將描述它的創(chuàng)建背景。

我正在開發(fā)一個名為 Accel Record 的 ORM。¹與一般 ORM 不同，Accel Record 旨在通過同步接口執(zhí)行 DB 訪問。² 同步執(zhí)行 DB 訪問的部分是通過在以child_process模塊??啟動的子進(jìn)程中執(zhí)行異步進(jìn)程來實(shí)現(xiàn)的。³我認(rèn)為通過使用worker_threads而不是child_process，我可以減少運(yùn)行時的開銷。

Accel Record 在可用性方面也設(shè)計(jì)得類似于 Ruby on Rails 的 Active Record，而我未來想要實(shí)現(xiàn)的目標(biāo)之一就是創(chuàng)建一個像 CarrierWave 這樣的庫。 CarrierWave允許您在保存記錄時將圖像保存到外部存儲服務(wù)（例如AWS S3），而要使用Accel Record來實(shí)現(xiàn)這一點(diǎn)，需要同步執(zhí)行圖像上傳等異步過程。我希望通過使用worker_threads而不是子進(jìn)程可以更快地執(zhí)行這個進(jìn)程。

所以我曾經(jīng)尋找過一個使用worker_threads同步執(zhí)行異步進(jìn)程的庫。我發(fā)現(xiàn)了幾個庫，例如synckit和deasync，但它們都沒有按照我的預(yù)期工作，所以我決定創(chuàng)建自己的庫。從那時起，我就想制作一個可以通過 TypeScript 以類型安全方式使用的接口。

更多內(nèi)部細(xì)節(jié)

• 直到worker_threads啟動的子線程中的異步進(jìn)程完成之前，使用Atomic.wait()阻塞主線程。
• MessageChannel 用于線程之間的通信。 synckit的源碼對于這部分的實(shí)現(xiàn)非常有幫助。
• 當(dāng)使用worker_threads啟動Worker時，需要將.ts文件轉(zhuǎn)譯為.js。對于這部分，我使用 esbuild。
• 啟動 Worker 時，我想將轉(zhuǎn)譯后的源代碼作為字符串傳遞給 Worker 執(zhí)行，但它在我的環(huán)境中無法正常工作。這是我最掙扎的部分。最后，我將文件寫在node_modules下，并將其路徑傳遞給Worker。這個方法被證明是最穩(wěn)定的。

1. “Accel Record”簡介：使用 Active Record 模式的 TypeScript ORM ?

2. 為什么我們?yōu)樾碌?TypeScript ORM 采用同步 API ?

3. TypeScript 中的同步數(shù)據(jù)庫訪問技術(shù)?

以上是發(fā)布了一個用于 JS/TS 異步進(jìn)程同步執(zhí)行的庫的詳細(xì)內(nèi)容。更多信息請關(guān)注PHP中文網(wǎng)其他相關(guān)文章！