ts-docs-type-递归器

将 ts-docs 节点树引入类型签名 hast。 。 。 .

由此产生的快活树可以通过任何超标兼容框架(即JSX类似,如React,Vue等)来提供.

给定的树上附加了每个符号的类名,以便可以相应突出显示,链接包括: data-link 属性,以在更多的信息下能够制取弹出物.

使用量

通过使用 TypeRenderer 和提供 doc 节点:

import {TypeRenderer} from '@faulty/ts-docs-type-renderer';

const renderer = new TypeRenderer(links, renderOptions);
const result = renderer.render(typeNode);

然后将快取树转换成框架的合适结构,例如反应:

import * as React from 'react';
import {toH} from 'hast-to-hyperscript';

return toH(React.createElement, result);

对于反应,有一个方便组件可以自动处理:

import {Type, TypeContext} from '@faulty/ts-docs-type-renderer/react';

<TypeContext.Provider links={links}>
  <Type type={typeNode} />
</TypeContext.Provider>