Type alias FileParserConfig<Result, Output, CustomTags>Internal

FileParserConfig<Result, Output, CustomTags>: Pick<CommentTagParserConfig<CustomTags>, "excludeTags" | "testBlockTagNames" | "tagSeparator" | "getTypeChecker" | "tsDocParser"> & {
    filePath: keyof Result;
    result: Result[];
    resultMapper: ((result, testBlockDocComments) => Output);
    sourceFilesMap: Record<string, SourceFile | undefined>;
}

Type Parameters

  • Result extends object

  • Output extends object

  • CustomTags extends string = AllTagsName

Type declaration

  • filePath: keyof Result
  • result: Result[]
  • resultMapper: ((result, testBlockDocComments) => Output)
      • (result, testBlockDocComments): Output
      • Parameters

        Returns Output

  • sourceFilesMap: Record<string, SourceFile | undefined>

Generated using TypeDoc