Options
All
  • Public
  • Public/Protected
  • All
Menu

typedoc-wrapper

Index

Functions

Functions

Const run

  • run(mainFile: string, __namedParameters?: Partial<{ customTagsJSONFile: string; hideGenerator: boolean; postArgs: string | string[]; preArgs: string | string[]; themeDir: string }>): PromiseWithChild<{ stderr: string; stdout: string }>
  • Parameters

    • mainFile: string

      Relative or absolute path to the file or dir to execute on

    • __namedParameters: Partial<{ customTagsJSONFile: string; hideGenerator: boolean; postArgs: string | string[]; preArgs: string | string[]; themeDir: string }> = ...

    Returns PromiseWithChild<{ stderr: string; stdout: string }>