# @dchighs/dc-config 中文文档

规范地址：https://npmcn.com/package/%40dchighs/dc-config/

版本：0\.1\.183
npm 元数据更新时间：2026-11-11T19:30:21.744Z
中文译文更新时间：2026-11-11T19:17:34.372Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40dchighs/dc-config
原文对照：https://npmcn.com/package/%40dchighs/dc-config/?lang=original
项目主页：https://github.com/DC-Highs/dc-config#readme
源码仓库：https://github.com/DC-Highs/dc-config

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

- 包体积（解压后）：95.1 kB，19 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：@dchighs/dc-core ^0\.4\.2
- 首次发布：2026-01-07T19:58:03.141Z
- 最新版本发布：2026-11-11T19:30:21.510Z
- 近 30 天下载量：4400（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：100（近 12 个月 100 个）

## 中文简介

处理龙城配置的库.

## 安装

```sh
npm install @dchighs/dc-config
```

也可以使用：`pnpm add @dchighs/dc-config`、`yarn add @dchighs/dc-config`、`bun add @dchighs/dc-config`

## README

# @dchighs/dc-配置

> ⚠️ **说明**:不要问我如何获得你的URL,Auth Token,或用户ID;我不会回答你. 如果你不知道如何使用这个, 是因为你不应该.

**@dchighs/dc-配置** 是用于访问游戏配置数据的软件包 [龙城](https://dragoncitygame.com/) (这不是官方SocialPoint图书馆,是粉丝制作的).

## \* 安装

安装是直截了当的 – 简单使用您的首选软件包管理器 。 以下是利用国家预防机制的例子:

```cmd
npm i @dchighs/dc-config
```

## 使用量

[![Buy Me A Coffee](https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png)](https://www.buymeacoffee.com/marcuth)

### 获取特定参数的配置

创建 `Config` 例如,您需要提供证书或使用静态 `.create()` 提供必要的参数:

```ts
import { Config, ConfigLanguage, ConfigPlatform, ConfigFilter } from "@dchighs/dc-config"

;(async () => {
    const userId = process.env.USER_ID
    const authToken = process.env.AUTH_TOKEN
    const url = process.env.URL

    const config = await Config.create({
        url: url,
        userId: userId,
        authToken: authToken,
        language: ConfigLanguage.Turkish, // optional - "en" is default
        platform: ConfigPlatform.Android, // optional - "ios" is default
        filter: [ConfigFilter.Items] // optional - undefined is default
    })

    const data = config.data

    console.log(data)
})();
```

* * *

### 从文件中装入已保存的配置

如果您有保存的包含配置数据的JSON文件,并想加载它以使用类来进行操作,您可以按以下方式完成: 1

```ts
import { Config, ConfigLanguage, ConfigPlatform, GameConfigDto } from "@dchighs/dc-config"
import fs from "node:fs"

;(async () => {
    const filePath = "config.json"
    const contentString = await fs.promises.readFile(filePath, { encoding: "utf-8" })
    const data = JSON.parse(contentString) as GameConfigDto

    const config = new Config({
        language: ConfigLanguage.Turkish,
        platform: ConfigPlatform.Android,
        data: data
    })
})();
```

* * *

### 从 URL 获取原始配置

如果您有完整的原始 JSON 文件并想要取回并过滤特定密钥 :

```ts
import { Config, ConfigFilter, ConfigLanguage } from "@dchighs/dc-config"

;(async () => {
    const rawUrl = "https://example.com/config.json"
    
    // Using createRaw to get a Config instance
    const config = await Config.createRaw({
        url: rawUrl,
        filter: [ConfigFilter.Items],
        language: ConfigLanguage.English
    })

    // Or using fetchRaw to get just the data (GameConfigDto)
    const data = await Config.fetchRaw({
        url: rawUrl,
        filter: [ConfigFilter.Items]
    })
})();
```

* * *

## 捐款

-   想贡献吗? 遵循这些步骤:
-   叉出宝库.
-   创建新分支( N)`git checkout -b feature-new`) (中文(简体) ).
-   提交更改( E)`git commit -m 'Add new feature'`) (中文(简体) ).
-   推向分行(`git push origin feature-new`) (中文(简体) ).
-   打开拉出请求.

* * *

## 许可证

这个项目根据麻省理工学院的许可证获得许可.

## 常见问题

### @dchighs/dc-config 是什么？

处理龙城配置的库\.

### 如何安装 @dchighs/dc-config？

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

### @dchighs/dc-config 支持 TypeScript 吗？

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

### @dchighs/dc-config 支持 ESM 还是 CommonJS？

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

### @dchighs/dc-config 可以商用吗？

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

### @dchighs/dc-config 的下载量有多少？

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

### @dchighs/dc-config 还在维护吗？

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