synckit

使用worker_threads在Node.js中同步执行异步工作，并提供一流的TypeScript和Yarn P'n'P支持。

使用方法
- 安装
- API
- 类型
- 选项
- 环境变量
- TypeScript
基准测试
赞助商
支持者
更新日志
许可证

使用方法

安装

# yarn
yarn add synckit

# npm
npm i synckit

API

// runner.js
import { createSyncFn } from 'synckit'

// worker路径必须是绝对路径
const syncFn = createSyncFn(require.resolve('./worker'), {
  tsRunner: 'tsx', // 可选，可以是 `'ts-node' | 'esbuild-register' | 'esbuild-runner' | 'tsx'`
})

// 你可以做任何你想做的事，你会同步获得结果！
const result = syncFn(...args)

// worker.js
import { runAsWorker } from 'synckit'

runAsWorker(async (...args) => {
  // 执行耗时的工作
  return result
})

你必须确保result可以通过结构化克隆算法进行序列化。

类型

export interface GlobalShim {
  moduleName: string
  /**
   * `undefined` 表示仅有副作用
   */
  globalName?: string
  /**
   * 1. `undefined` 或空字符串表示 `default`，例如:
   * ```js
   * import globalName from 'module-name'
   * ```
   *
   * 2. `null` 表示命名空间，例如:
   * ```js
   * import * as globalName from 'module-name'
   * ```
   *
   */
  named?: string | null
  /**
   * 如果不是 `false`，仅当原始 `globalName` 不可用时才应用该 shim，
   * 例如，你可能只想在原生 `globalThis.fetch` 不可用时进行 polyfill：
   * ```js
   * import fetch from 'node-fetch'
   *
   * if (!globalThis.fetch) {
   *   globalThis.fetch = fetch
   * }
   * ```
   */
  conditional?: boolean
}

选项

execArgv 与环境变量 SYNCKIT_EXEC_ARGV 相同
globalShims: 类似于环境变量 SYNCKIT_GLOBAL_SHIMS，但更加灵活，可以是 GlobalShim 数组，详见 GlobalShim 的定义
timeout 与环境变量 SYNCKIT_TIMEOUT 相同
transferList: 请参阅 Node.js worker_threads 文档
tsRunner 与环境变量 SYNCKIT_TS_RUNNER 相同

环境变量

SYNCKIT_EXEC_ARGV: 传递给 worker 的 node CLI 选项列表，用逗号 , 分隔。（默认为 []），另见 node 文档
SYNCKIT_GLOBAL_SHIMS: 是否启用默认的 DEFAULT_GLOBAL_SHIMS_PRESET 作为 globalShims
SYNCKIT_TIMEOUT: 执行异步任务的 timeout（无默认值）
SYNCKIT_TS_RUNNER: 使用哪种 TypeScript 运行器，对开发很有用，可以是 'ts-node' | 'esbuild-register' | 'esbuild-runner' | 'swc' | 'tsx'，默认使用 'ts-node'，请确保已安装相应的包