@amazon/vinyl-observable

中文文档
5.0.0发布于 2026/11/16Apache-2.0TypeScriptESM + CJS构建来源已验证近 30 天下载 2737

A simple active model

原始使用文档
文档目录8 节
  1. Install
  2. ObservableValue<T>
  3. Key Features
  4. Example
  5. Utilities
  6. combineData
  7. externalData
  8. License

@amazon/vinyl-observable

Website npm size

A small, typed observable value primitive for state tracking without a third-party reactivity system. Under 1 KiB minified + gzipped.

Install

npm install @amazon/vinyl-observable

ObservableValue<T>

An ObservableValue<T> represents a reactive, read-only data container that can be observed for changes over time.

Key Features

  • Reactive: subscribers are notified on value changes.
  • Composable: derive new observable values using map and pick.
  • Typed: strong type safety for both value and callback arguments.
  • Lightweight: minified and gzipped bundle size is under 1 KiB.

Example

Use data to create a MutableValue for a data type.

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

Utilities

combineData

Combines multiple data providers into a single record, notifying observers when any have changed.

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"

The combined onValue callback is invoked synchronously; every change from every sub-provider is delivered. See throttle in @amazon/vinyl-util to handle frequent changes.

externalData

Creates an ObservableValue that integrates with an external data source. Data is only actively fetched or listened to when a subscriber calls onData, allowing lazy subscription to external event systems such as WebSocket, polling, or other push-based updates.

Returns an ObservableValue<T> that:

  • Emits initialValue immediately on subscription.
  • Receives future values from onDataRequested.
  • Automatically unsubscribes from the external source when no listeners remain.
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()

License

Apache-2.0

版本与发布记录

@amazon/vinyl-observable 共发布 44 个版本,首次发布于 2026/05/28;过去 12 个月发布了 44 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
5.0.0latest2026/11/16今天
4.1.1-next.20261115174554next2026/11/16今天
4.1.1-next.202611151724472026/11/16今天
4.1.1-next.202611151644392026/11/16今天
4.1.1-next.202611150013552026/11/151 天前
4.1.1-next.202611131749092026/11/142 天前

其他发布通道:hotfix-chromos → 1.2.1,hotfix-close-drm-sessions → 1.2.2,next → 4.1.1-next.20261115174554。

关于 @amazon/vinyl-observable 的常见问题

@amazon/vinyl-observable 是什么?

A simple active model

如何安装 @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 和提交记录判断。