Source
Extraction
Extracts marked TypeScript code snippets from documentation text.
Details
Extraction uses an ordered text scan and does not parse the containing source file.
Signature
declare function extract(source: string, format: SourceFormat): readonly Array<Snippet> Since v4.0.0 Source
Reads a file and extracts its marked code snippets.
Signature
declare function extractFile(file: string): Promise<readonly Array<Snippet>>Guards
Since v4.0.0 Source
Returns whether a file uses Markdown or MDX documentation syntax.
Signature
declare function isMarkdown(file: string): booleanModels
Represents an executable TypeScript code snippet.
Signature
interface Snippet { readonly line: number; readonly name: string | undefined; readonly source: string;}SourceFormat
type Since v4.0.0 Source
Identifies how documentation is embedded in the source text.
Signature
type SourceFormat = "jsdoc" | "markdown"