Documenter

Effects

• extractApiPackage

Errors

• DocumentationError

Effects

extractApiPackage

Extracts the API package and saves the markdown files to the output folder

Signature

export declare const extractApiPackage: (
  apiPath: string,
  outputFolder: string,
) => RTE.ReaderTaskEither<
  FileService.FileService & Prettier.PrettierConfig,
  FileService.FileServiceError | DocumentationError,
  void
>

Details

• Added in 0.1.0

Errors

DocumentationError

Represents an error which occurs when extracting the API package

Signature

export declare class DocumentationError extends Error

constructor(context: string, error: unknown);

Details

• Added in 0.1.0

Properties and Methods

context (property)

readonly context: string;

name (property)

readonly name = "DocumentationError";