# @armrest/client 中文文档

规范地址：https://npmcn.com/package/%40armrest/client/

版本：0\.2\.2
npm 元数据更新时间：2025-12-11T01:30:27.730Z
中文译文更新时间：2026-11-06T19:55:28.689Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40armrest/client
原文对照：https://npmcn.com/package/%40armrest/client/?lang=original
项目主页：https://github.com/payload-code/armrest-node#readme
源码仓库：https://github.com/payload-code/armrest-node

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

- 包体积（解压后）：140 kB，30 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：2 个
- 首次发布：2023-05-24T01:22:42.952Z
- 最新版本发布：2025-12-11T01:30:27.340Z
- 近 30 天下载量：4505（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 1 个）

## 中文简介

节点.js Armrest 客户端库

## 安装

```sh
npm install @armrest/client
```

也可以使用：`pnpm add @armrest/client`、`yarn add @armrest/client`、`bun add @armrest/client`

## README

# Armrest Node.js 客户端库

用于创建 Armrest 客户端的节点.js 库 .

## 安装

## 使用 npm 安装

```bash
npm install @armrest/client
```

## 开始

**无害环境管理**

```javascript
import Armrest from '@armrest/client'
```

### 创建新 api

```javascript
const API = new Armrest('http://armrest-api-url')
  .model('Example')

const api = API.Session('api-key')
```

### 创建对象

```javascript
const example = await api.Example.create({
  test: 'attribute'
})
```

### 更新对象

```javascript
await example.update({ test: 'changevalue' })
```

### 选择对象

对象可以使用任意属性选择.

```javascript
const results = await api.select(api.Example).filterBy({ test: 'value' })
```

使用 `filter`。 。 。 .

```javascript
const results = api.Example.filter(
    pl.or(
       pl.Example.test.eq('value'),
       pl.Example.test.eq('othervalue')
    )
)
```

## 常见问题

### @armrest/client 是什么？

节点\.js Armrest 客户端库

### 如何安装 @armrest/client？

在项目目录运行 npm install @armrest/client，或使用 pnpm add / yarn add / bun add。

### @armrest/client 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/armrest\_\_client 是否存在。

### @armrest/client 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @armrest/client 可以商用吗？

@armrest/client 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @armrest/client 的下载量有多少？

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

### @armrest/client 还在维护吗？

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