fix: types

Author: gera2ld

src/template.ts

@@ -1,4 +1,4 @@
-import { JSItem } from './types';
+import { JSItem, IMarkmapCreateOptions } from './types';
 import { persistJS, persistPlugins } from './util';
 import { mathJax, prism } from './plugins';
 
@@ -14,7 +14,7 @@ const baseJs: JSItem[] = [
   },
 }));
 
-export function fillTemplate(data: any, opts?: any): string {
+export function fillTemplate(data: any, opts?: IMarkmapCreateOptions): string {
   const { js, css, processors } = persistPlugins([
     opts?.mathJax && mathJax,
     opts?.prism && prism,

src/types.ts

@@ -1,22 +1,56 @@
 import { Markmap } from './view';
 
 export interface IHierachy<T> {
+  /**
+   * type
+   */
   t: string;
+  /**
+   * payload
+   */
   p?: any;
+  /**
+   * children
+   */
   c?: T[];
 }
 
 export interface INode extends IHierachy<INode> {
+  /**
+   * depth
+   */
   d?: number;
+  /**
+   * value
+   */
   v: string;
 }
 
 export interface IMarkmapCreateOptions {
+  /**
+   * whether to open the generated markmap in browser
+   */
   open?: boolean;
+  /**
+   * Markdown content as string. It will be ignored if `input` is provided.
+   */
   content?: string;
+  /**
+   * Input file path of a Markdown file. If this is provided, `content` will be ignored.
+   */
   input?: string;
+  /**
+   * Output file path of the markmap HTML file. If not provided, the same basename as the Markdown input file will be used.
+   */
   output?: string;
+  /**
+   * Enable MathJax support. If an object is passed, it will be merged into MathJax options.
+   */
   mathJax?: boolean | object;
+  /**
+   * Enable Prism support for code blocks.
+   */
+  prism?: boolean;
 }
 
 export interface IMarkmapOptions {