Options
All
  • Public
  • Public/Protected
  • All
Menu

Module definitions

Index

Type Aliases

Parser: ((contents: string, file: string) => TodoComment[])

Type declaration

    • receive the contents and file and return a list of parsed items

      Parameters

      • contents: string
      • file: string

      Returns TodoComment[]

ParserFactory: ((config: ParserFactoryConfig) => Parser)

Type declaration

ReportItems: ((comments: TodoComment[], config: any) => any)

Type declaration

    • Report the provided items

      Parameters

      Returns any

ReporterName: string
Tag: string

Sometimes referred to as kind, this is usually a TODO or FIXME but can be any custom string

TransformComment: ((file: string, line: number, ref: string, tag: Tag, text: string) => string | string[])

Type declaration

    • (file: string, line: number, ref: string, tag: Tag, text: string): string | string[]
    • Parameters

      • file: string
      • line: number
      • ref: string
      • tag: Tag
      • text: string

      Returns string | string[]

TransformHeader: ((tag: Tag) => string | string[])

Type declaration

    • (tag: Tag): string | string[]
    • Parameters

      Returns string | string[]

Generated using TypeDoc