Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SourcePlugin

A handler that attaches source file information to reflections.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Private basePath

basePath: BasePath = new BasePath()

Helper for resolving the base path of all source files.

componentName

componentName: string

The name of this component as set by the @Component decorator.

Private fileMappings

fileMappings: object

A map of all generated SourceFile instances.

Type declaration

Accessors

application

owner

Methods

Protected bubble

getOptionDeclarations

Private getSourceFile

initialize

  • initialize(): void

listenTo

listenToOnce

off

  • off(): any
  • off(eventMap: EventMap, context?: any): any
  • off(name: string, callback?: EventCallback, context?: any): any

on

  • on(eventMap: EventMap, context?: any): any
  • on(eventMap: EventMap, callback?: EventCallback, context?: any, priority?: number): any
  • on(name: string, callback: EventCallback, context?: any, priority?: number): any

Private onBegin

  • onBegin(): void

Private onBeginDocument

  • Triggered when the converter begins converting a source file.

    Create a new SourceFile instance for all TypeScript files.

    Parameters

    • context: Context

      The context object describing the current state the converter is in.

    • reflection: Reflection

      The reflection that is currently processed.

    • Optional node: SourceFile

      The node that is currently processed if available.

    Returns void

Private onBeginResolve

  • onBeginResolve(context: Context): void

Private onDeclaration

  • Triggered when the converter has created a declaration reflection.

    Attach the current source file to the DeclarationReflection.sources array.

    Parameters

    • context: Context

      The context object describing the current state the converter is in.

    • reflection: Reflection

      The reflection that is currently processed.

    • Optional node: Node

      The node that is currently processed if available.

    Returns void

Private onEndResolve

  • onEndResolve(context: Context): void
  • Triggered when the converter has finished resolving a project.

    Parameters

    • context: Context

      The context object describing the current state the converter is in.

    Returns void

Private onResolve

  • Triggered when the converter resolves a reflection.

    Parameters

    • context: Context

      The context object describing the current state the converter is in.

    • reflection: Reflection

      The reflection that is currently resolved.

    Returns void

once

  • once(eventMap: EventMap, context?: any): any
  • once(name: string, callback: EventCallback, context?: any, priority?: any): any
  • Bind an event to only be triggered a single time. After the first time the callback is invoked, its listener will be removed. If multiple events are passed in using the space-separated syntax, the handler will fire once for each event, not once for a combination of all events.

    Parameters

    • eventMap: EventMap
    • Optional context: any

    Returns any

  • Parameters

    • name: string
    • callback: EventCallback
    • Optional context: any
    • Optional priority: any

    Returns any

stopListening

trigger

  • Trigger one or many events, firing all bound callbacks. Callbacks are passed the same arguments as trigger is, apart from the event name (unless you're listening on "all", which will cause your callback to receive the true name of the event as the first argument).

    Parameters

    Returns this

Generated using TypeDoc