Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GitHubPlugin

A handler that watches for repositories with GitHub origin and links their source files to the related GitHub pages.

Hierarchy

Implements

Index

Constructors

constructor

Properties

componentName

componentName: string

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

gitRevision

gitRevision: string

Private ignoredPaths

ignoredPaths: string[] = []

List of paths known to be not under git control.

Private repositories

repositories: object

List of known repositories.

Type declaration

Accessors

application

owner

Methods

Protected bubble

getOptionDeclarations

Private getRepository

  • Check whether the given file is placed inside a repository.

    Parameters

    • fileName: string

      The name of the file a repository should be looked for.

    Returns Repository

    The found repository info or NULL.

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 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

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