@glyphjs/types
Shared TypeScript type definitions for the Glyph JS ecosystem.
Install
pnpm add @glyphjs/types
Usage
import type { GlyphIR, Block, CompilationResult } from '@glyphjs/types';
const doc: GlyphIR = {
version: '0.1',
documentId: 'doc-1',
metadata: { title: 'Hello' },
blocks: [],
references: [],
};
What's included
- IR types --
GlyphIR, Block, Reference, CompilationResult, and related interfaces
- AST types --
GlyphRoot, GlyphUIBlock, RawRef for the parsed markdown AST
- Block data types --
HeadingData, ParagraphData, CodeData, ListData, and more
- Patch types --
GlyphPatch, GlyphPatchOperation for IR diffing/patching
- Runtime types --
GlyphRuntime, GlyphTheme, BlockProps, GlyphRuntimeConfig
- Plugin types --
GlyphComponentDefinition, GlyphComponentProps
Docs
https://github.com/VledicFranco/glyphjs
关于 @glyphjs/types 的常见问题
@glyphjs/types 是什么?
Shared TypeScript type definitions for Glyph JS
如何安装 @glyphjs/types?
在项目目录运行 npm install @glyphjs/types,或使用 pnpm add / yarn add / bun add。
@glyphjs/types 支持 TypeScript 吗?
支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。
@glyphjs/types 支持 ESM 还是 CommonJS?
以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。
@glyphjs/types 可以商用吗?
@glyphjs/types 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。
@glyphjs/types 的下载量有多少?
根据 npm 官方下载统计,@glyphjs/types 在 2026/10/17 – 2026/11/15 这 30 天内被下载 2,949 次,日均约 98 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。
@glyphjs/types 还在维护吗?
最新版本 0.10.0 发布于 2026/04/19(6 个月前);至今共发布 12 个版本,其中过去 12 个月发布了 12 个;首次发布于 2026/02/05。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。