Kind: Class
Source: atloria-monorepo/apps/config-docs-parser/src/parsers/markdown.parser.ts
Implements: IParser
Methods
| Method | Signature | Returns |
|---|---|---|
initialize | initialize(config: ParserConfig) | Promise<void> |
canParse | canParse(filePath: string) | boolean |
parseFile | parseFile(filePath: string, content: string) | Promise<ParseResult> |
parseFiles | parseFiles(files: ParseFileInput[]) | Promise<ParseResult[]> |
destroy | destroy() | Promise<void> |
Properties
| Property | Type |
|---|---|
name | any |
version | any |
supportedPatterns | any |
Where it refuses work
MarkdownParserstops the work withErrorwhen!content— “Content is required for parsing”.MarkdownParserstops the work with an early return whentypeMap[baseName].MarkdownParserstops the work with an early return when/guide/i.test(fileName).MarkdownParserstops the work with an early return when/tutorial/i.test(fileName).MarkdownParserstops the work with an early return when/api/i.test(fileName).MarkdownParserstops the work with an early return when/docs?/i.test(filePath).
When something fails
MarkdownParserhandles failure in 1 place: it turns it into a return value in all 1.
Was this page helpful?