Class IncludePlugin

constructor

• new IncludePlugin(owner: Converter): IncludePlugin

  Parameters

  • owner: Converter

  Returns IncludePlugin

componentName

application

• get application(): Application

  Return the application / root component instance.

  Returns Application

logger

• get logger(): Logger

  Returns Logger

owner

• get owner(): O

  Return the owner of this component.

  Returns O

checkIncludeTagsParts

• checkIncludeTagsParts(
      refl: Reflection,
      relative: string,
      parts: CommentDisplayPart[],
      included?: string[],
  ): void

  Parameters

  • refl: Reflection
  • relative: string
  • parts: CommentDisplayPart[]
  • Optionalincluded: string[]

  Returns void

getLines

• getLines(
      refl: Reflection,
      file: string,
      textPart: string,
      text: string,
      requestedLines: string,
      tag: string,
  ): string

  Parameters

  • refl: Reflection
  • file: string
  • textPart: string
  • text: string
  • requestedLines: string
  • tag: string

  Returns string

getRegions

• getRegions(
      refl: Reflection,
      file: string,
      ext: string,
      textPart: string,
      text: string,
      regionTargets: string,
      tag: string,
      ignoreIndent: boolean,
  ): string

  Parameters

  • refl: Reflection
  • file: string
  • ext: string
  • textPart: string
  • text: string
  • regionTargets: string
  • tag: string
  • ignoreIndent: boolean

  Returns string

off

• off<K extends never>(
      event: K,
      listener: (this: undefined, ...args: {}[K]) => void,
  ): void

  Stops listening to an event.

  Type Parameters

  • K extends never

  Parameters

  • event: K

    the event to stop listening to.

  • listener: (this: undefined, ...args: {}[K]) => void

    the function to remove from the listener array.

  Returns void

on

• on<K extends never>(
      event: K,
      listener: (this: undefined, ...args: {}[K]) => void,
      priority?: number,
  ): void

  Starts listening to an event.

  Type Parameters

  • K extends never

  Parameters

  • event: K

    the event to listen to.

  • listener: (this: undefined, ...args: {}[K]) => void

    function to be called when an this event is emitted.

  • Optionalpriority: number

    optional priority to insert this hook with. Higher priority is placed earlier in the listener array.

  Returns void

trigger

• trigger<K extends never>(event: K, ...args: {}[K]): void

  Emits an event to all currently subscribed listeners.

  Type Parameters

  • K extends never

  Parameters

  • event: K

    the event to emit.

  • ...args: {}[K]

    any arguments required for the event.

  Returns void