@hyperframes/core

中文文档
0.8.226发布于 2026/11/01TypeScriptES Module构建来源已验证

用于超帧视频框架的类型、解析器、生成器、编译器、筛选器、运行时和帧适配器。

中文使用文档
文档目录8 节
  1. 安装
  2. 里面有什么
  3. 生成的组合信任
  4. 帧适配器
  5. 解析和生成HTML
  6. 产品毛羽
  7. 文档
  8. 相关的包

@hyperframes /核心

用于超帧视频框架的类型、解析器、生成器、编译器、筛选器、运行时和帧适配器。

安装

npm install @hyperframes/core

大多数用户不需要直接安装core 命令行界面, 生产商, 工作室 包在内部依赖于它。

里面有什么

模块描述
类型TimelineElement, CompositionSpec, Asset,画布尺寸,默认值
解析器parseHtml -从HTML中提取时间轴元素; parseGsapScript -解析GSAP动画
发电机generateHyperframesHtml -从组合规范中生成有效的超框架HTML
编译器compileTimingAttrs ——解决 data-start / data-duration 变成绝对时间
剥绒机lintHyperframeHtml -验证超帧HTML(缺少属性,重叠轨道等)
运行时IIFE脚本注入到浏览器-管理查找,媒体播放,和 window.__hf 协议
帧适配器可插入的动画驱动程序(GSAP、Lottie、CSS或自定义)

生成的组合信任

组合生成器需要受信任的作者提供承载代码的输入。 styles 和 generateHyperframesStyles 保留可加载外部资源的编写CSS。 animations 可能包含 __raw: 作为JavaScript发出的值; includeScripts: true 包括可执行的时间线代码。 serializeGsapAnimations 也接受raw preamble, postamble,以及密码方位 timelineVar。永远不要把 这些输入包含不可信的数据。属性编码和结束标记包含 不是沙盒;以适当隔离的方式呈现不可信的组合 执行环境,永远不要在特权源上为它们提供服务。

文本内容保留支持的内联格式清理程序契约。的剪辑 Parser有意将内部格式扁平化为文本,因此parse/generate不会 编辑源HTML的无损替代品。

帧适配器

帧适配器告诉引擎如何将你的动画寻找到一个特定的帧:

import { createGSAPFrameAdapter } from "@hyperframes/core";

const adapter = createGSAPFrameAdapter({
  getTimeline: () => gsap.timeline(),
  compositionId: "my-video",
});

实现 FrameAdapter 对于自定义动画运行时:

import type { FrameAdapter } from "@hyperframes/core";

const myAdapter: FrameAdapter = {
  id: "my-adapter",
  getDurationFrames: () => 300,
  seekFrame: (frame) => {
    /* seek your animation */
  },
};

解析和生成HTML

import { parseHtml, generateHyperframesHtml } from "@hyperframes/core";

const { elements, metadata } = parseHtml(htmlString);
const html = generateHyperframesHtml(spec);

产品毛羽

import { lintHyperframeHtml } from "@hyperframes/core/lint";

const result = lintHyperframeHtml(htmlString);
// result.findings: { severity, message, elementId }[]

文档

完整的文档: hyperframes.heygen.com/packages/core

版本与发布记录

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

版本发布日期距今
0.8.226latest2026/11/012 天前
0.8.2252026/11/012 天前
0.8.2242026/11/012 天前
0.8.2232026/10/313 天前
0.8.2222026/10/313 天前
0.8.2212026/10/304 天前

其他发布通道:alpha → 0.7.67-alpha.0,desktop → 0.8.53-desktop.0,hdr → 0.8.190-hdr.1。

关于 @hyperframes/core 的常见问题

@hyperframes/core 是什么?

用于超帧视频框架的类型、解析器、生成器、编译器、筛选器、运行时和帧适配器。

如何安装 @hyperframes/core?

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

@hyperframes/core 支持 TypeScript 吗?

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

@hyperframes/core 支持 ESM 还是 CommonJS?

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

@hyperframes/core 可以商用吗?

@hyperframes/core 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@hyperframes/core 还在维护吗?

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