Skip to content

Parser

Parses TypeScript declarations and JSDoc into docgen models.

10 exports Added in v0.6.0 Source

Parsing

parseClasses

Added in v0.6.0 Source

Parses exported classes and their documented members from the current source file.

Signature

declare const parseClasses: Effect<any, never, Source>;

parseConstants

Added in v0.6.0 Source

Parses exported non-function constants from the current source file.

Signature

declare const parseConstants: Effect<Array<Constant>, never, Source>;

parseExports

Added in v0.6.0 Source

Parses explicit export declarations from the current source file.

Signature

declare const parseExports: Effect<any, never, Source>;

parseFiles

Added in v0.6.0 Source

Parses source files into module documentation models sorted by path.

Signature

declare function parseFiles(files: readonly Array<File>): Effect<Array<Module>, [Array<string>, ...Array<Array<string>>], Path | Configuration | Process>

parseFunctions

Added in v0.6.0 Source

Parses exported function declarations and function-valued variables.

Signature

declare const parseFunctions: Effect<Array<Function>, never, Source>;

parseInterfaces

Added in v0.6.0 Source

Parses exported interfaces from the current source file.

Signature

declare const parseInterfaces: Effect<Array<Interface>, never, Source>;

parseModule

Added in v0.6.0 Source

Parses the current source file into a module documentation model.

Signature

declare const parseModule: Effect<Module, never, Configuration | Source>;

parseNamespaces

Added in v0.6.0 Source

Parses exported namespaces from the current source file.

Signature

declare const parseNamespaces: Effect<Array<Namespace>, never, Configuration | Source>;

parseTypeAliases

Added in v0.6.0 Source

Parses exported type aliases from the current source file.

Signature

declare const parseTypeAliases: Effect<Array<TypeAlias>, never, Source>;

Services

SourceShape interface

Added in v0.6.0 Source

Source file and path currently being parsed.

Signature

interface SourceShape {
  readonly path: readonly [string, string];
  readonly sourceFile: SourceFile;
}