# @fasterfixes/core 中文文档

规范地址：https://npmcn.com/package/%40fasterfixes/core/

版本：0\.4\.0
npm 元数据更新时间：2026-11-12T11:58:40.129Z
中文译文更新时间：2026-11-14T11:01:41.776Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40fasterfixes/core
原文对照：https://npmcn.com/package/%40fasterfixes/core/?lang=original
项目主页：https://faster-fixes.com/
源码仓库：https://github.com/manucoffin/faster-fixes

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

- 包体积（解压后）：44.6 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：0 个
- 首次发布：2026-03-20T08:32:53.128Z
- 最新版本发布：2026-11-12T11:58:39.748Z
- 近 30 天下载量：27106（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 12 个）

## 中文简介

用于快取反馈部件的核心客户端库 。 处理API通信,反馈提交,以及审查者认证.

## 安装

```sh
npm install @fasterfixes/core
```

也可以使用：`pnpm add @fasterfixes/core`、`yarn add @fasterfixes/core`、`bun add @fasterfixes/core`

## README

# @ fasterfixes/ 核心

> **[文档](https://faster-fixes.com/docs)** • 妇女 [网站](https://faster-fixes.com/)

核心客户端库 [更快的图像](https://faster-fixes.com/) ——网络应用的视觉反馈工具.

此软件包提供快捷Fixes部件使用的 API 客户端、 类型和公用设备 。 大多数用户应安装 [`@fasterfixes/react`](https://www.npmjs.com/package/@fasterfixes/react) 相反,它自动包括这个软件包.

## 安装

```bash
npm install @fasterfixes/core
```

## 使用量

```typescript
import { FasterFixesClient } from "@fasterfixes/core";

const client = new FasterFixesClient({
  apiKey: "your-project-api-key",
});

// Fetch widget configuration
const config = await client.getConfig();

// Submit feedback
await client.createFeedback(
  {
    comment: "Button is misaligned on mobile",
    pageUrl: window.location.href,
    selector: "main > div > button",
    clickX: 150,
    clickY: 320,
  },
  reviewerToken,
  screenshotBlob, // optional
);

// Fetch feedback for a page
const { feedback } = await client.getFeedback(reviewerToken, pageUrl);
```

## API 密码

### `FasterFixesClient`

| 方法 | 说明 |
| --- | --- |
| `getConfig()` | 获取部件配置( 启用状态) |
| `getFeedback(token, url?)` | 获取反馈项目, 可选择通过页面 URL 过滤 |
| `createFeedback(data, token, screenshot?)` | 用可选截图提交新反馈 |
| `updateFeedback(id, data, token)` | 更新现有反馈注释 |
| `deleteFeedback(id, token)` | 删除反馈项目 |

### `ApiError`

被所有客户端的方法 扔在非OK反应。 扩展 `Error`。 。 。 .

| 财产 | 类型 | 说明 |
| --- | --- | --- |
| `status` | `number` | HTTP 状态代码 |
| `message` | `string` | API 的错误消息 |
| `details` | `unknown` | 其他错误细节 |

### 公用事业

| 导出 | 说明 |
| --- | --- |
| `generateSelector(element)` | 生成 DOM 元素的最佳 CSS 选择器 |
| `generateSelectors(element)` | 生成多个选择策略并返回最稳定的策略 `best` |
| `resolveElement(selector, strategies?)` | 使用主选择器找到元素, 按优先级顺序通过策略返回 |
| `captureElementContext(element, selectors)` | 获取关于 DOM 元素的丰富上下文( 描述、 React 组件路径、 相邻文本) |
| `getBrowserInfo()` | 检测浏览器名称、版本、 OS 和视图大小 |
| `resolveReviewerToken()` | 从 URL parm 中解析审查器令牌( E)`ff_token`)或本地图集 |

### 类型

所有类型脚本都导出,包括: `WidgetConfig`, (中文(简体) ), `WidgetPosition`, (中文(简体) ), `FeedbackItem`, (中文(简体) ), `FeedbackStatus`, (中文(简体) ), `CreateFeedbackData`, (中文(简体) ), `UpdateFeedbackData`, (中文(简体) ), `SelectorStrategies`, (中文(简体) ), `ElementContext`, (中文(简体) ), `ClientOptions`, (中文(简体) ), `Labels`还有更多.

### 常数

有用常数也被导出 : `FEEDBACK_STATUSES`, (中文(简体) ), `WIDGET_POSITIONS`, (中文(简体) ), `STATUS_COLORS`, (中文(简体) ), `DEFAULT_LABELS`, (中文(简体) ), `DEFAULT_WIDGET_COLOR`, (中文(简体) ), `DEFAULT_WIDGET_POSITION`。 。 。 .

## 许可证

[麻省理工学院](https://npmcn.com/package/%40fasterfixes/core/LICENSE)

## 常见问题

### @fasterfixes/core 是什么？

用于快取反馈部件的核心客户端库 。 处理API通信,反馈提交,以及审查者认证\.

### 如何安装 @fasterfixes/core？

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

### @fasterfixes/core 支持 TypeScript 吗？

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

### @fasterfixes/core 支持 ESM 还是 CommonJS？

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

### @fasterfixes/core 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @fasterfixes/core 可以商用吗？

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

### @fasterfixes/core 的下载量有多少？

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

### @fasterfixes/core 还在维护吗？

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