Parser

Parses TypeScript declarations and JSDoc into docgen models.

10 exports Since v0.6.0 Source

Parsing

parseClasses

Since v0.6.0

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

Signature

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

parseConstants

Since v0.6.0

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

Signature

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

parseExports

Since v0.6.0

Parses explicit export declarations from the current source file.

Signature

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

parseFiles

Since v0.6.0

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

Since v0.6.0

Parses exported function declarations and function-valued variables.

Signature

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

parseInterfaces

Since v0.6.0

Parses exported interfaces from the current source file.

Signature

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

parseModule

Since v0.6.0

Parses the current source file into a module documentation model.

Signature

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

parseNamespaces

Since v0.6.0

Parses exported namespaces from the current source file.

Signature

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

parseTypeAliases

Since v0.6.0

Parses exported type aliases from the current source file.

Signature

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

Services

SourceShape

interface

Since v0.6.0

Source file and path currently being parsed.

Signature

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