MdxParser

reference

1 min readUpdated 2026-07-30

Kind: Class

Source: atloria-monorepo/apps/config-docs-parser/src/parsers/mdx.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

MdxParser stops the work with Error when !content — “Content is required for parsing”.
MdxParser stops the work with an early return when trimmed && !trimmed.startsWith('#') && !trimmed.startsWith('```') && !trimmed.startsWith(….

When something fails

MdxParser handles failure in 1 place: it turns it into a return value in all 1.

Was this page helpful?

Download as PDF

ADocs generated by Atloria — from the code, always in sync →