# @alicloud/console-base-error-prompt 中文文档

规范地址：https://npmcn.com/package/%40alicloud/console-base-error-prompt/

版本：1\.12\.0
npm 元数据更新时间：2026-10-29T09:54:59.346Z
中文译文更新时间：2026-11-06T22:31:57.889Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40alicloud/console-base-error-prompt
原文对照：https://npmcn.com/package/%40alicloud/console-base-error-prompt/?lang=original
项目主页：https://github.com/aliyun/alibabacloud-console-base/tree/master/packages/console-base-error-prompt
源码仓库：https://github.com/aliyun/alibabacloud-console-base

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

- 包体积（解压后）：95 kB，87 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：9 个
- peer 依赖：react \>=16\.8，styled-components \>=5
- 首次发布：2020-12-01T02:14:57.733Z
- 最新版本发布：2026-10-29T09:54:59.143Z
- 近 30 天下载量：2249（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：220（近 12 个月 10 个）

## 中文简介

控制台Base QQ

## 安装

```sh
npm install @alicloud/console-base-error-prompt
```

也可以使用：`pnpm add @alicloud/console-base-error-prompt`、`yarn add @alicloud/console-base-error-prompt`、`bun add @alicloud/console-base-error-prompt`

## README

# @alicloud/console-base-error-prompt

TODO see in action

> `@alicloud/error-prompt` 的进化版，不再依赖 wind 和 fusion，也不需要手动引样式和指定语言，更不再是一个工厂。

## 使用

### 一般用法

```tsx
import errorPrompt from '@alicloud/console-base-error-prompt';

errorPrompt(error/*, extra*/);
```

`error` 可以是以下类型：

-   `undefined | null` 将被忽略
-   字符串
-   JSX
-   plain 对象
-   扩展了的 Error 实例对象

如果 error 是对象，除了标准属性 message 之外，可以附加 code、requestId，同时可以有 `details` 属性，长这样：

```typescript
interface IErrorDetails {
  url?: string;
  method?: string;
  params?: string | Record<string, unkonwn>;
  body?: string | Record<string, unkonwn>;
}
```

### 自定义标题、按钮

有的时候，会根据 `code` 可能需要调整 `title` 和 `button`。

```typescript
errorPrompt(error, {
  button,
  title
});

// 或
errorPrompt(error, ({ // 这里是解析后的对象，保证存在，但不保证有 code
  code
}) => {
  if (code === 'ConsoleNeedLogin') {
    return {
      title: '你妹登录 - 需要国际化',
      button: {
        href: '/',
        target: '_blank',
        label: '登录 - 需要国际化'
      }
    };
  }
});
```

### 如何忽略错误

所谓「忽略」错误，是指虽然被接收，但不会弹窗。

虽然可以用 `null | undefined`，是的，在 JS 中 `null | undefined` 是可以被当成错误的存在，但这并不是推荐的做法。

这种场景下，可以利用帮助方法 `createErrorToIgnore` throw 一个新错误，这个错误一定会被忽略。

```typescript
import {
  createErrorToIgnore
} from '@alicloud/console-base-error-prompt';

try {
  doMyStuff();
} catch (err) {
  // 可以忽略该错误，或错误在业务层已经被处理
  if (canIgnoreError(err)) {
    throw createErrorToIgnore();
  }
}
```

## 常见问题

### @alicloud/console-base-error-prompt 是什么？

控制台Base QQ

### 如何安装 @alicloud/console-base-error-prompt？

在项目目录运行 npm install @alicloud/console-base-error-prompt，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=16\.8）、styled-components（\>=5）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @alicloud/console-base-error-prompt 支持 TypeScript 吗？

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

### @alicloud/console-base-error-prompt 支持 ESM 还是 CommonJS？

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

### @alicloud/console-base-error-prompt 可以商用吗？

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

### @alicloud/console-base-error-prompt 的下载量有多少？

根据 npm 官方下载统计，@alicloud/console-base-error-prompt 在 2026/10/06 – 2026/11/04 这 30 天内被下载 2,249 次，日均约 75 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @alicloud/console-base-error-prompt 还在维护吗？

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