Skip to main content Link Search Menu Expand Document (external link)
docgen

Parser overview

Added in v1.0.0

Table of contents

parsers

parseClasses

Signature

export declare const parseClasses: Effect.Effect<Domain.Class[], string[], Configuration.Configuration | Source>

Added in v1.0.0

parseConstants

Signature

export declare const parseConstants: Effect.Effect<Domain.Constant[], string[], Configuration.Configuration | Source>

Added in v1.0.0

parseExports

Signature

export declare const parseExports: Effect.Effect<Domain.Export[], string[], Configuration.Configuration | Source>

Added in v1.0.0

parseFiles

Signature

export declare const parseFiles: (
  files: ReadonlyArray<File.File>
) => Effect.Effect<Domain.Module[], string[][], Process.Process | Configuration.Configuration | Path.Path>

Added in v1.0.0

parseFunctions

Signature

export declare const parseFunctions: Effect.Effect<Domain.Function[], string[], Configuration.Configuration | Source>

Added in v1.0.0

parseInterfaces

Signature

export declare const parseInterfaces: Effect.Effect<Domain.Interface[], string[], Configuration.Configuration | Source>

Added in v1.0.0

parseModule

Signature

export declare const parseModule: Effect.Effect<
  Domain.Module,
  string[],
  Configuration.Configuration | Path.Path | Source
>

Added in v1.0.0

parseNamespaces

Signature

export declare const parseNamespaces: Effect.Effect<Domain.Namespace[], string[], Configuration.Configuration | Source>

Added in v1.0.0

parseTypeAliases

Signature

export declare const parseTypeAliases: Effect.Effect<Domain.TypeAlias[], string[], Configuration.Configuration | Source>

Added in v1.0.0