@agentshouse/mdmodel
已打入 Markdown 文档: 在 JSON Schema 中声明的 MD 类型, 文件在其中写入其值 马克下体,一个读取器,一个编剧和一个验证器,一个结构化修改文档的决定性应用,和一个查询语言 在 SQL 中对一个收藏或在一个文档的内存进行回答,加上符合 固定装置.
它在浏览器和节点运行,不进行网络呼叫,不读取
文件系统。 它运送了一个无害环境管理文物,即第24.22.1号节点,以及后来
装入通过 import 或者说 require。 。 。 .
安装
npm install @agentshouse/mdmodel
使用量
import { apply, parse, serialize, validate, verify } from '@agentshouse/mdmodel';
const checked = verify('task:\n properties:\n title: { type: string, title: Title }\n');
if (checked.verdict === 'accept') {
const task = checked.model.types.task;
validate({ 'one.md': '---\ntype: task\n---\n- **Title**: Ship\n' }, undefined, checked.model);
const parsed = parse('---\ntype: task\n---\n- **Title**: Hello\n', 'one.md', task);
if (parsed.ok) {
const change = { kind: 'field', name: 'title', value: 'World', prior: 'Hello' } as const;
const next = apply(parsed.document, [change], task);
if (next.outcome === 'applied') serialize(next.document);
}
}
API 密码
| 导出 | 目的 |
|---|---|
verify | 校验一个 MD 类型模型的图案文本 |
validate | 验证文本库; 返回接受或一次拒绝 |
parse, (中文(简体) ), serialize | 读取并写入一个文档 |
apply | 立即应用字段、部分、序言、链接和引用更改 |
links, (中文(简体) ), target, (中文(简体) ), retarget | 库存和重写链接目的地 |
escapePointer | 将一个键写为 JSON 指针符号 |
project, (中文(简体) ), divide | 嵌入投影输入及其分解为 Spans |
facts, (中文(简体) ), candidateOf | 一个文件如一个更改所示, 匹配为一个查询候选人 |
planOf, (中文(简体) ), matches, (中文(简体) ), sql | 检查查询, 在一个文档上回答, 或将其编译到 SQL |
VERSION | MD 模式版本 |
MEMBER_FIELD, (中文(简体) ), SITE_FIELD, (中文(简体) ), SUBMITTED_FIELD | 前题密钥的校验数为类型之外的已声明 |
MEDIA_TYPES, (中文(简体) ), servedMediaType | 媒体类型 House 和 文件扩展列表 |
全文见 API.md符合性及其
判决格式和规则编号如下: fixtures/README.md。 。 。 .
许可证
麻省理工学院