# @amazon/vinyl-observable 中文文档

规范地址：https://npmcn.com/package/%40amazon/vinyl-observable/

版本：5\.0\.0
npm 元数据更新时间：2026-11-16T02:14:53.519Z
中文译文更新时间：2026-11-16T02:19:49.004Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40amazon/vinyl-observable
原文对照：https://npmcn.com/package/%40amazon/vinyl-observable/?lang=original
项目主页：https://github.com/amazonmusic/vinyl#readme
源码仓库：https://github.com/amazonmusic/vinyl

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

- 包体积（解压后）：224 kB，27 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2026-05-27T23:27:10.803Z
- 最新版本发布：2026-11-16T02:14:53.092Z
- 近 30 天下载量：2737（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：44（近 12 个月 44 个）

## 中文简介

一个简单的活动模型

## 安装

```sh
npm install @amazon/vinyl-observable
```

也可以使用：`pnpm add @amazon/vinyl-observable`、`yarn add @amazon/vinyl-observable`、`bun add @amazon/vinyl-observable`

## README

# @amazon/ vinyl-可观测

[![Website](https://img.shields.io/badge/website-amazonmusic.github.io%2Fvinyl-blue)](https://amazonmusic.github.io/vinyl) [![npm](https://img.shields.io/npm/v/@amazon/vinyl-observable.svg)](https://www.npmjs.com/package/@amazon/vinyl-observable) [![size](https://img.shields.io/bundlejs/size/@amazon/vinyl-observable.svg?label=size)](https://bundlejs.com/?q=@amazon/vinyl-observable)

用于状态跟踪的小型可观察值原始 第三方反应系统。 1KiB分解后加克齐普.

## 安装

```shell
npm install @amazon/vinyl-observable
```

## 可观察值<T>

一个 `ObservableValue<T>` 代表一个可 以时间变化来观察.

### 关键特性

-   反应:在值变化时通知订阅者.
-   可编译: 使用 `map` 财务报告和审定财务报表 `pick`。 。 。 .
-   已打入:对值和回调参数都具有强型安全性.
-   轻量级:精密和克齐普捆绑尺寸低于1KiB.

### 示例

使用 `data` 创建 `MutableValue` 用于数据类型.

```typescript
import { data } from '@amazon/vinyl-observable'

const user$ = data({ name: 'Alice', age: 30 })

const name$ = user$.pick('name')
name$.onData((name) => {
    console.log('Name changed:', name)
})

user$.value = { name: 'Bob', age: 30 }
// Logs: "Name changed: Bob"

const age$ = user$.pick('age')
age$.value = 31

user$.value.age // 31
```

## 公用事业

### 组合数据

将多个数据提供者合并为一个记录,在 任何改变.

```typescript
import { combineData, data } from '@amazon/vinyl-observable'

const a = data(1)
const b = data('x')
const combined = combineData({ a, b })

combined.onValue((v) => {
    console.log('changed: ', v.a, v.b)
})

a.value = 2
// Logs: "changed: 2 x"
b.value = 'y'
// Logs: "changed: 2 y"
```

这个 `combined` `onValue` 回调被同步引用; 从 每个分供应商都交付。 见 `throttle` 内 [`@amazon/vinyl-util`](https://npmcn.com/package/%40amazon/vinyl-util) 用于处理频繁的更改.

### 外部数据

创建一个 `ObservableValue` 与外部数据源合并。 数据 仅在订阅者拨打时主动获取或收听 `onData`, (中文(简体) ), 允许懒惰地订阅诸如WebSocket,投票等外部活动系统, 或其他基于推力的更新.

返回 a `ObservableValue<T>` 即:

-   输出 `initialValue` 即刻订入.
-   接收来自 `onDataRequested`。 。 。 .
-   在没有留有听众时自动从外部来源取消订阅 .

```typescript
import { externalData } from '@amazon/vinyl-observable'

const timeData = externalData<Date>(new Date(), (setData) => {
    const interval = setInterval(() => {
        setData(new Date())
    }, 1000)

    return () => clearInterval(interval)
})

const unsubscribe = timeData.onData((now) => {
    console.log('Current time:', now)
})

// Later, to stop receiving updates
unsubscribe()
```

## 许可证

阿帕奇 - 2.0

## 常见问题

### @amazon/vinyl-observable 是什么？

一个简单的活动模型

### 如何安装 @amazon/vinyl-observable？

在项目目录运行 npm install @amazon/vinyl-observable，或使用 pnpm add / yarn add / bun add。

### @amazon/vinyl-observable 支持 TypeScript 吗？

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

### @amazon/vinyl-observable 支持 ESM 还是 CommonJS？

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

### @amazon/vinyl-observable 可以商用吗？

@amazon/vinyl-observable 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @amazon/vinyl-observable 的下载量有多少？

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

### @amazon/vinyl-observable 还在维护吗？

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

