Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PackagePlugin

A handler that tries to find the package.json and readme.md files of the current project.

The handler traverses the file tree upwards for each file processed by the processor and records the nearest package info files it can find. Within the resolve files, the contents of the found files will be read and appended to the ProjectReflection.

Hierarchy

Implements

Index

Constructors

constructor

Properties

componentName

componentName: string

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

Private noReadmeFile

noReadmeFile: boolean

Should the readme file be ignored?

Private packageFile

packageFile: string

The file name of the found package.json file.

readme

readme: string

Private readmeFile

readmeFile: string

The file name of the found readme.md file.

Private visited

visited: string[]

List of directories the handler already inspected.

Accessors

application

owner

Methods

Protected bubble

getOptionDeclarations

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

Private onBeginDocument

  • Triggered when the converter begins converting a source file.

    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

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