@cloudflare/workers-wasi

中文文档
0.0.5发布于 2022/02/08BSD-3-ClauseTypeScriptES Module零依赖近 30 天下载 1.4万

Work in progress

原始使用文档
文档目录7 节
  1. Work in progress
  2. Usage
  3. Development
  4. Build with Docker
  5. Testing
  6. Notes
  7. TODO (remove)

Workers WASI

Work in progress

An experimental implementation of the WebAssembly System Interface designed to run on Cloudflare Workers

Usage

import { WASI } from '@cloudflare/workers-wasi';
import mywasm from './mywasm.wasm';

const wasi = new WASI();
const instance = new WebAssembly.Instance(mywasm, {
   wasi_snapshot_preview1: wasi.wasiImport
});

await wasi.start(instance);

Development

Install Rust and nvm then run

nvm use --lts

Build and test

git clone --recursive [email protected]:cloudflare/workers-wasi.git
cd ./workers-wasi
make -j test

Build with Docker

git clone --recursive [email protected]:cloudflare/workers-wasi.git
cd ./workers-wasi
cat ./Dockerfile | docker build -t workers-wasi-build -
docker run --rm -it -v $(pwd):/workers-wasi workers-wasi-build

Testing

We aim to be interchangeable with other WASI implementations. Integration tests are run locally using Miniflare against the following test suites:

Notes

An ephemeral filesystem implementation built on littlefs is included. Both soft and hard links are not yet supported.

The following syscalls are not yet supported and return ENOSYS

  • fd_readdir
  • path_link
  • path_readlink
  • path_symlink
  • poll_oneoff
  • sock_recv
  • sock_send
  • sock_shutdown

Timestamps are captured using Date.now() which has unique behavior on the Workers platform for security reasons. This affects the implementation of

  • clock_res_get
  • clock_time_get
  • fd_filestat_set_times
  • path_filestat_set_times

TODO (remove)

Misc TODO:

  • path_rename (update old path for existing open fds)
  • fix preopens interface (use object), and update options docs
  • document difference between nodejs options and ours (streams/fs)
  • fd_close (stdio)
  • fd_renumber (stdio)
  • fd_read/fd_write does not work with renumbering stdio
  • update file timestamps appropriately

版本与发布记录

@cloudflare/workers-wasi 共发布 4 个版本,首次发布于 2021/12/15;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.0.5latest2022/02/084 年前
0.0.42022/02/014 年前
0.0.22021/12/164 年前
0.0.12021/12/154 年前

关于 @cloudflare/workers-wasi 的常见问题

@cloudflare/workers-wasi 是什么?

Work in progress

如何安装 @cloudflare/workers-wasi?

在项目目录运行 npm install @cloudflare/workers-wasi,或使用 pnpm add / yarn add / bun add。

@cloudflare/workers-wasi 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@cloudflare/workers-wasi 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@cloudflare/workers-wasi 可以商用吗?

@cloudflare/workers-wasi 使用 BSD-3-Clause 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。另外不得用原作者名义为衍生产品背书。以上为概括,不构成法律意见,请以许可原文为准。

@cloudflare/workers-wasi 的下载量有多少?

根据 npm 官方下载统计,@cloudflare/workers-wasi 在 2026/10/10 – 2026/11/08 这 30 天内被下载 14,463 次,日均约 482 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@cloudflare/workers-wasi 还在维护吗?

最新版本 0.0.5 发布于 2022/02/08(4 年前);至今共发布 4 个版本,其中过去 12 个月发布了 0 个;首次发布于 2021/12/15。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。