Constructors
constructor
- new APIHandler(content?: string, fullPath: string): APIHandler
-
Parameters
-
Default value content: string = ""
-
fullPath: string
Properties
fullPath
fullPath: string
markdownIt
markdownIt: MarkdownIt
Methods
getTOCFromAPI
-
Parameters
-
Default value showTitle: APIShowTitle = APIShowTitle['simplified']
getTOCFromContent
- getTOCFromContent(content: string, to?: string, options?: { maxLevel: number; minLevel: number }): TOCLink[]
-
Parameters
-
content: string
-
Optional to: string
-
Default value options: { maxLevel: number; minLevel: number } = { maxLevel: 3, minLevel: 3 }
-
maxLevel: number
-
minLevel: number
getTOCFromFile
- getTOCFromFile(fullPath: string, to?: string, options?: { maxLevel: number; minLevel: number }): Promise<TOCLink[]>
-
Parameters
-
fullPath: string
-
Optional to: string
-
Default value options: { maxLevel: number; minLevel: number } = { maxLevel: 3, minLevel: 3 }
-
maxLevel: number
-
minLevel: number
Returns Promise<TOCLink[]>
markdown
- markdown(): Promise<string>
markdownAPI
-
Parameters
-
Default value showTitle: APIShowTitle = APIShowTitle['as-needed']
Returns string
markdownARIA
- markdownARIA(aria: Array<AriaAPI>): string
-
Parameters
Returns string
markdownAttrs
- markdownAttrs(attrs: Array<AttrAPI>): string
-
Parameters
Returns string
markdownComputed
-
Parameters
Returns string
markdownData
- markdownData(data: Array<DataAPI>): string
-
Parameters
Returns string
markdownEvents
- markdownEvents(events: Array<EventAPI>): string
-
Parameters
Returns string
markdownIndex
- markdownIndex(): Promise<string>
markdownMethods
- markdownMethods(methods: Array<MethodAPI>, type?: string): string
-
Parameters
Returns string
markdownOptions
- markdownOptions(options: Array<OptionAPI>): string
-
Parameters
Returns string
markdownSlots
- markdownSlots(slots: Array<SlotAPI>): string
-
Parameters
Returns string
markdownTOC
- markdownTOC(tocLinks: Array<TOCLink>, vue?: boolean, level?: number, toHashMap?: Map<string, true>): string
-
Parameters
-
tocLinks: Array<TOCLink>
-
Default value vue: boolean = false
-
Default value level: number = 0
-
Default value toHashMap: Map<string, true> = new Map()
Returns string
parse
- parse(content: string): any
toVetur
- toVetur(): { attributes: {}; tags: {} }
-
Returns { attributes: {}; tags: {} }
处理组件 API 的类 用于修改、保存，以及生成 Markdown 文档等功能