# @distilled\.cloud/workos 中文文档

规范地址：https://npmcn.com/package/%40distilled.cloud/workos/

版本：1\.0\.0-rc\.19
npm 元数据更新时间：2026-11-11T23:31:33.329Z
中文译文更新时间：2026-11-12T12:01:03.929Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40distilled.cloud/workos
原文对照：https://npmcn.com/package/%40distilled.cloud/workos/?lang=original
源码仓库：https://github.com/alchemy-run/distilled

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：2.2 MB，44 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：effect ^4\.1\.2
- 首次发布：2026-04-29T22:32:45.897Z
- 最新版本发布：2026-11-11T23:31:32.968Z
- 近 30 天下载量：6097（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：82（近 12 个月 82 个）

## 中文简介

暂无中文简介

## 安装

```sh
npm install @distilled.cloud/workos
```

也可以使用：`pnpm add @distilled.cloud/workos`、`yarn add @distilled.cloud/workos`、`bun add @distilled.cloud/workos`

## README

# @ distilled. cloud/ workos (中文(简体) )

SDK 用于 [工作间](https://www.npmjs.com/package/@distilled.cloud/workos)。 。 。 .

## 安装

```bash
npm install @distilled.cloud/workos effect
```

## 快开始

```ts
import { Effect, Layer } from "effect";
import * as FetchHttpClient from "effect/http/FetchHttpClient";
import * as Workos from "@distilled.cloud/workos";

const program = Effect.gen(function* () {
  const result = yield* Workos.ListOrganizationsController({});
  return result;
});

const Live = Layer.mergeAll(
  FetchHttpClient.layer,
  Workos.CredentialsFromEnv,
  Workos.WorkosProtocol,
);

program.pipe(Effect.provide(Live), Effect.runPromise);
```

## 认证

要求 : `WORKOS_API_KEY`可选: `WORKOS_API_URL`发送为 `Authorization: Bearer`。 。 。 .

## 常见问题

### 如何安装 @distilled\.cloud/workos？

在项目目录运行 npm install @distilled\.cloud/workos，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：effect（^4\.1\.2）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @distilled\.cloud/workos 支持 TypeScript 吗？

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

### @distilled\.cloud/workos 支持 ESM 还是 CommonJS？

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

### @distilled\.cloud/workos 可以商用吗？

@distilled\.cloud/workos 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @distilled\.cloud/workos 的下载量有多少？

根据 npm 官方下载统计，@distilled\.cloud/workos 在 2026/10/13 – 2026/11/11 这 30 天内被下载 6,097 次，日均约 203 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @distilled\.cloud/workos 还在维护吗？

最新版本 1\.0\.0-rc\.19 发布于 2026/11/12（今天）；至今共发布 82 个版本，其中过去 12 个月发布了 82 个；首次发布于 2026/04/30。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。