Class FlowrAnalyzerRdTopicIndexFilePlugin

Readonlytype

Readonlyversion

StaticdefaultPlugin

• defaultPlugin(): FlowrAnalyzerFilePlugin

  Returns a default/dummy implementation to be used when no plugin of this type is registered or triggered.

  Returns FlowrAnalyzerFilePlugin

applies

• applies(file: PathLike): boolean

  Determine whether this plugin applies to the given file.

  Parameters

  • file: PathLike

  Returns boolean

process

• process(
      _ctx: FlowrAnalyzerContext,
      file: FlowrFileProvider,
  ): FlowrRdTopicIndexFile

  Parameters

  • _ctx: FlowrAnalyzerContext
  • file: FlowrFileProvider

  Returns FlowrRdTopicIndexFile

processor

• processor(
      context: FlowrAnalyzerContext,
      args: FlowrFileProvider,
  ):
      | FlowrFileProvider<{ toString(): string }>
      | [file: FlowrFileProvider<{ toString(): string }>, cont: boolean]

  Run the plugin with the given context and arguments.

  Parameters

  • context: FlowrAnalyzerContext
  • args: FlowrFileProvider

  Returns
      | FlowrFileProvider<{ toString(): string }>
      | [file: FlowrFileProvider<{ toString(): string }>, cont: boolean]