发布了一个用于 JS/TS 异步进程同步执行的库

我发布了一个名为sync-actions 的库，它允许异步进程在 JavaScript/TypeScript 中同步执行。特别是在 TypeScript 中，您可以以类型安全的方式调用定义的函数。它适用于您想要在您不希望（或不能）标记为异步的函数中执行异步进程的情况。

特征

• 利用 Node.jsworker_threads
  • 异步进程在子线程中执行，主线程同步等待其完成。
• 类型安全的函数调用
  • 在 TypeScript 中，您可以利用已定义函数的类型信息。
• 作为原生 ESM 发布
  • 由于不支持 CommonJS，它变得简单。

存储库

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

用法

安装

它作为 npm 包发布，因此请使用 npm install 或类似的方式安装它。

npm install sync-actions

基本用法

通过将返回Promise对象的异步函数传递给defineSyncWorker()，您可以定义接口并使用launch()启动工作线程。假设定义工作程序的文件是与其他处理文件分开创建的。

// 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();

类型安全的函数调用

在 TypeScript 中，您可以以类型安全的方式调用使用 DefineSyncWorker 定义的函数。

// 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();
</number>

// 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();

背景

到目前为止的内容与README相同，所以我将描述它的创建背景。

我正在开发一个名为 Accel Record 的 ORM。¹与一般 ORM 不同，Accel Record 旨在通过同步接口执行 DB 访问。² 同步执行 DB 访问的部分是通过在以child_process模块​​启动的子进程中执行异步进程来实现的。³我认为通过使用worker_threads而不是child_process，我可以减少运行时的开销。

Accel Record 在可用性方面也设计得类似于 Ruby on Rails 的 Active Record，而我未来想要实现的目标之一就是创建一个像 CarrierWave 这样的库。 CarrierWave允许您在保存记录时将图像保存到外部存储服务（例如AWS S3），而要使用Accel Record来实现这一点，需要同步执行图像上传等异步过程。我希望通过使用worker_threads而不是子进程可以更快地执行这个进程。

所以我曾经寻找过一个使用worker_threads同步执行异步进程的库。我发现了几个库，例如synckit和deasync，但它们都没有按照我的预期工作，所以我决定创建自己的库。从那时起，我就想制作一个可以通过 TypeScript 以类型安全方式使用的接口。

更多内部细节

• 直到worker_threads启动的子线程中的异步进程完成之前，使用Atomic.wait()阻塞主线程。
• MessageChannel 用于线程之间的通信。 synckit的源码对于这部分的实现非常有帮助。
• 当使用worker_threads启动Worker时，需要将.ts文件转译为.js。对于这部分，我使用 esbuild。
• 启动 Worker 时，我想将转译后的源代码作为字符串传递给 Worker 执行，但它在我的环境中无法正常工作。这是我最挣扎的部分。最后，我将文件写在node_modules下，并将其路径传递给Worker。这个方法被证明是最稳定的。

---

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

2. 为什么我们为新的 TypeScript ORM 采用同步 API ↩

3. TypeScript 中的同步数据库访问技术↩

以上是发布了一个用于 JS/TS 异步进程同步执行的库的详细内容。更多信息请关注PHP中文网其他相关文章！