@getaster/data

中文文档
0.4.72发布于 2026/11/16Apache-2.0TypeScriptES Module构建来源已验证近 30 天下载 3968

DOM-free reactive data models for metadata-driven OData applications.

原始使用文档
文档目录5 节
  1. Install
  2. Read a collection
  3. What the core provides
  4. Documentation and support
  5. License

@getaster/data

Reactive data models for metadata-driven OData applications. Aster's data core shares records, queries, selections and edit state across views without depending on the DOM or a UI framework.

Use it on its own for application state, or with @getaster/elements for grids, forms and other browser controls.

Install

npm install @getaster/data

The package provides ES modules and TypeScript declarations. Node.js consumers require Node 22 or later. Browser consumers need a modern ES-module environment and a bundler or import map that resolves npm dependencies.

Read a collection

This example requires an OData service with JSON CSDL metadata and a Projects entity set. Replace the service URL with your endpoint.

import { DataContext, fetchTransport } from '@getaster/data';

const ctx = await DataContext.connect(
  fetchTransport('https://your-service.example/odata/')
);
const projects = ctx.collection({ set: 'Projects' }, { pageSize: 50 });

try {
  await projects.view(0, 20);
  if (projects.error.value) throw projects.error.value;
  console.log(projects.items.value.slice(0, 20));
} finally {
  ctx.release(projects);
}

DataContext.connect() reads the service metadata. A collection represents a query and loads a bounded window of records; items, status and error expose reactive state. Release a collection when its owner no longer needs it.

What the core provides

  • A shared record store so confirmed changes reach all connected views.
  • Paging, filtering, sorting, grouping, summaries and hierarchical data models.
  • Selections, edit drafts, validation and conflict handling.
  • Composable commands, lifetimes and keyed sessions for application ownership.
  • A transport boundary for HTTP services, authentication and local test services.

Service capabilities determine which queries and writes are supported. The server must enforce authorization and write concurrency; client-side field visibility and validation are not security boundaries. Configure authentication and CORS for your deployment. For local examples without a server, use @getaster/mock.

The only runtime dependency is @preact/signals-core. The package has no install scripts and contains no UI controls, fonts, charting runtime or mock WebAssembly.

Documentation and support

License

Apache-2.0. See the included LICENSE and package-specific NOTICE. Separately installed dependencies retain their own licenses.

版本与发布记录

@getaster/data 共发布 20 个版本,首次发布于 2026/10/21;过去 12 个月发布了 20 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.4.72latest2026/11/16今天
0.4.472026/11/141 天前
0.4.422026/11/133 天前
0.4.402026/11/133 天前
0.4.382026/11/123 天前
0.4.352026/11/123 天前

其他发布通道:next → 0.1.0-preview.1。

关于 @getaster/data 的常见问题

@getaster/data 是什么?

DOM-free reactive data models for metadata-driven OData applications.

如何安装 @getaster/data?

在项目目录运行 npm install @getaster/data,或使用 pnpm add / yarn add / bun add。

@getaster/data 支持 TypeScript 吗?

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

@getaster/data 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@getaster/data 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@getaster/data 可以商用吗?

@getaster/data 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@getaster/data 的下载量有多少?

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

@getaster/data 还在维护吗?

最新版本 0.4.72 发布于 2026/11/16(今天);至今共发布 20 个版本,其中过去 12 个月发布了 20 个;首次发布于 2026/10/21。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。