# @codefresh-io/docker-reference 中文文档

规范地址：https://npmcn.com/package/%40codefresh-io/docker-reference/

版本：0\.1\.0
npm 元数据更新时间：2026-11-01T11:51:10.173Z
中文译文更新时间：2026-11-10T06:41:36.628Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：149 kB，23 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2017-06-04T06:32:49.449Z
- 最新版本发布：2026-01-25T07:25:12.787Z
- 近 30 天下载量：6411（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 1 个）

## 中文简介

解析多克图像引用的节点.js 包

## 安装

```sh
npm install @codefresh-io/docker-reference
```

也可以使用：`pnpm add @codefresh-io/docker-reference`、`yarn add @codefresh-io/docker-reference`、`bun add @codefresh-io/docker-reference`

## README

# 多克参考

用于解析并处理 Docker 图像引用的小包 .

## 开始

要使用 Docker 引用, 您应该从创建 `Reference` 实例:

```js
const { Reference } = require('@codefresh-io/docker-reference');

const imageReference = new Reference({
    domain: 'r.cfcr.io',
    repository: 'codefresh/demochat',
    tag: 'master',
    digest: 'sha256:58fe87ff24d5a3ac35c887dcef82eb619565987c1083282f876c7c2657a5f94e'
});

console.log(imageReference.repositoryUrl); // r.cfcr.io/codefresh/demochat
console.log(imageReference.toString()); // r.cfcr.io/codefresh/demochat:master@sha256:58fe87ff24d5a3ac35c887dcef82eb619565987c1083282f876c7c2657a5f94e
```

## 使用解析器

您也可以使用 parser 创建您的 `Reference` 实例:

```js
const { parseQualifiedName } = require('@codefresh-io/docker-reference');

const imageReference = parseQualifiedName('r.cfcr.io/codefresh/demochat:master@sha256:58fe87ff24d5a3ac35c887dcef82eb619565987c1083282f876c7c2657a5f94e');

console.log(imageReference.domain);     // r.cfcr.io
console.log(imageReference.repository); // codefresh/demochat
console.log(imageReference.tag);        // master
console.log(imageReference.digest);     // sha256:58fe87ff24d5a3ac35c887dcef82eb619565987c1083282f876c7c2657a5f94e
```

软件包中有3个解析器:

1.  `parseQualifiedName`数字 :
    
    当解析一个代表合格图像的字符串时应当使用此选项 引用,指字符串至少应当包含域和 图像仓库.
    
2.  `parseFamiliarName`数字 :
    
    当解析一个代表熟悉图像的字符串时,应该使用此功能 引用,表示字符串可能不包含域部分和此 如果域部分变成 `docker.io`。当域是 缺少, 存储器只包含一个部分 前缀为 `library/`。 。 。 .
    
    **此解析器将解析所有符合条件的图像引用, 与 `parseQualifiedName` 解析器**
    
3.  `parseAll`数字 :
    
    当解析一个代表熟悉图像的字符串时,应该使用此功能 参考或标识符.
    
    **此解析器将解析所有符合条件的图像引用, 与 `parseQualifiedName` 解析并解析每个熟悉的图像引用 与 `parseFamiliarName`**
    

## 软件包的格莱默

|  | 花纹 |
| --- | --- |
| `reference` | `name [ ":" tag ] [ "@" digest ]` |
| `name` | `[domain '/'] path-component ['/' path-component]*` |
| `domain` | `domain-component ['.' domain-component]* [':' port-number]` |
| `domain-component` | \[a-zA-Z0-9\] (中文(简体) ) |
| `port-number` | `/[0-9]+/` |
| `path-component` | `alpha-numeric [separator alpha-numeric]*` |
| `alpha-numeric` | `/[a-z0-9]+/` |
| `separator` | \`/\[.\] |
| `tag` | `/[\w][\w.-]{0,127}/` |
| `digest` | `digest-algorithm ":" digest-hex` |
| `digest-algorithm` | `digest-algorithm-component [ digest-algorithm-separator digest-algorithm-component ]*` |
| `digest-algorithm-separator` | `/[+.-_]/` |
| `digest-algorithm-component` | `/[A-Za-z][A-Za-z0-9]*/` |
| `digest-hex` | `/[0-9a-fA-F]{32,}/` (至少128位文摘值) |
| `identifier` | `/[a-f0-9]{64}/` |
| `short-identifier` | `/[a-f0-9]{6,64}/` |

## 常见问题

### @codefresh-io/docker-reference 是什么？

解析多克图像引用的节点\.js 包

### 如何安装 @codefresh-io/docker-reference？

在项目目录运行 npm install @codefresh-io/docker-reference，或使用 pnpm add / yarn add / bun add。

### @codefresh-io/docker-reference 支持 TypeScript 吗？

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

### @codefresh-io/docker-reference 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @codefresh-io/docker-reference 可以商用吗？

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

### @codefresh-io/docker-reference 的下载量有多少？

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

### @codefresh-io/docker-reference 还在维护吗？

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