# @alicloud/console-one-config

> OneConsole Config 对象解析与封装

Latest version **1.5.3** (published 2025-07-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install @alicloud/console-one-config
pnpm add @alicloud/console-one-config
yarn add @alicloud/console-one-config
bun add @alicloud/console-one-config
```

## Health

**Score 40/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.5.3 |
| Published | 2025-07-01 |
| First published | 2020-12-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 18.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | jacksontian, fengmk2, pagecao, aliyunsdkteam, console-fe |

## Links

- npm: https://www.npmjs.com/package/@alicloud/console-one-config
- npm.io page: https://npm.io/package/@alicloud/console-one-config

## Recent versions

- 1.5.3 (latest) — 2025-07-01
- 1.5.2-beta.1 (beta) — 2025-06-25
- 1.5.2 — 2025-06-26
- 1.5.2-beta.0 — 2025-06-24
- 1.5.1 — 2025-05-08
- 1.5.1-beta.0 — 2025-04-28
- 1.5.0 — 2023-04-19
- 1.4.9 — 2023-03-24
- 1.4.8 — 2023-01-19
- 1.4.7 — 2023-01-05
- 1.4.6 — 2022-11-08
- 1.4.5 — 2022-11-08
- 1.4.4 — 2022-11-08
- 1.4.2 — 2022-10-12
- 1.4.0 — 2022-08-18
- … 103 more at https://npm.io/package/@alicloud/console-one-config/versions

## README

# @alicloud/console-one-config

> 仅输出对象和类型，可以不在 OneConsole 下使用（比如用在 console-base 中），但使用前必须做好判断 `ONE_CONF.one` 为 true 才是 OneConsole。

对 OneConsole 下 `window.ALIYUN_CONSOLE_CONFIG` 的封装，剔除不用的东西，纠正和明确类型。
在非 OneConsole 下同样可以得到类型一致的对象，但里边的数据都是空的。可以通过 `CONF.ONE` 是否为 `true` 判断当前是否为 OneConsole。

```shell
tnpm i @alicloud/console-one-config -S
```

```typescript
import ONE_CONF from '@alicloud/console-one-config';

// 使用 ONE_CONF
```

## 哪些优化？

* 对全局变量 `window.ALIYUN_CONSOLE_CONFIG` 只读一次，避免全局变量引起的安全漏洞
* 明确 `ONE_CONF` 的类型为优化后的 `ConsoleOneConfig`
* 剔除永远不会用到的输出
* 纠正类型，避免 `undefined`

更多优化可自行查看类型定义。

### `STATIS_API`

设计的无比狗屎，基本上可以认为是由**脚**设计出来的。它输出的原屎格式是 `{ code, data?, message? }`，使用时需要非常小心，因为很容易出错，
我看到有人用了一连串的 `&&` 来做保护。实际上这一层逻辑完全可以在 OneConsole 输出前进行剥离，我多次提出，但总以**稳定性**为借口不作为，稳定得令人发指。

所以，这里提取了 `data` 作为直接输出，并更名为 `API_RESULT`。

```typescript
STATIS_API: {
  a: {
    code: '200',
    data: ...
  },
  b: {
    code: '200',
    data: null // null 是正常的返回，不忽略
  },
  c: { // 由于 data 是 undefined，所以忽略
    code: '200'
  },
  d: {
    code: 'SomethingWrong',
    data: '即使有 data，但 code 是失败，也忽略',
    message: '...'
  }
}
// 将变成
API_RESULT: {
  a: ...,
  b: null
}
```

### OPEN_STATUS

改成了正确的格式，布尔是布尔，数值是数值。

### REGIONS

对 REGIONS 的类型做了精简。

---
_Source: https://npm.io/package/@alicloud/console-one-config · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._