Type alias TsDocTestReporterConfig<CustomTags>

TsDocTestReporterConfig<CustomTags>: Pick<CommentTagParserConfig<CustomTags>, "excludeTags" | "testBlockTagNames" | "tagSeparator"> & {
    customTags?: ITSDocTagDefinitionParameters[];
    onBeforeRender?: ((results) => UITestResult[]);
    outputFileName?: string;
    outputFileType?: OutputFileType;
    outputJsonAs?: "raw" | "ui";
    repoUrl?: string;
    tsConfigPath?: string;
    uiOptions?: UIOptions;
}

Main config for the reporter used by the consumer

Type Parameters

Type declaration

  • Optional customTags?: ITSDocTagDefinitionParameters[]
  • Optional onBeforeRender?: ((results) => UITestResult[])
      • (results): UITestResult[]

      • Callback that runs right before rendering result as UITestResult. Useful if you want to modify the information before rendering.

        Parameters

        Returns UITestResult[]

  • Optional outputFileName?: string

    Specifies the name of the generated file. Supports folders.

    Example

    "output"
    "reports/output"

    Default

    'tsdoc-test-reporter-report'
  • Optional outputFileType?: OutputFileType

    Default

    "html"
  • Optional outputJsonAs?: "raw" | "ui"

    Sets if output when json is raw data or the same data that is rendered when using HTML

    Default

    'raw'
  • Optional repoUrl?: string

    Set this to add link to origin remote

    Example

    { repoUrl: "https://github.com/tsdoc-test-reporter/reporter/blob/main" }
  • Optional tsConfigPath?: string

    Use this option if you have placed your tsconfig in a subfolder or have renamed your config. The reporter will otherwise look for the config in the root folder by default.

    Default

    './tsconfig.json'
  • Optional uiOptions?: UIOptions

    Options to configure the output of outputFileType: "html"

Settings

Member Visibility

Theme

Generated using TypeDoc