Options
All
  • Public
  • Public/Protected
  • All
Menu

Best effort make the service docs markdown looks better.

Hierarchy

  • ConverterComponent
    • SdkClientCommentUpdatePlugin

Implements

  • ComponentHost

Index

Constructors

constructor

Properties

componentName

componentName: string

Accessors

application

  • get application(): Application

owner

  • get owner(): Converter

Methods

Protected bubble

  • bubble(name: Event | EventMap | string, ...args: any[]): this
  • Parameters

    • name: Event | EventMap | string
    • Rest ...args: any[]

    Returns this

Private cleanEmptyCommentLines

  • cleanEmptyCommentLines(comment: string): string

getOptionDeclarations

  • getOptionDeclarations(): DeclarationOption[]

initialize

  • initialize(): void

listenTo

  • listenTo(obj: EventDispatcher, name: EventMap | string, callback?: EventCallback, priority?: number): this
  • Parameters

    • obj: EventDispatcher
    • name: EventMap | string
    • Optional callback: EventCallback
    • Optional priority: number

    Returns this

listenToOnce

  • listenToOnce(obj: EventDispatcher, eventMap: EventMap): any
  • listenToOnce(obj: EventDispatcher, name: string, callback: EventCallback, priority?: number): any
  • Parameters

    • obj: EventDispatcher
    • eventMap: EventMap

    Returns any

  • Parameters

    • obj: EventDispatcher
    • name: string
    • callback: EventCallback
    • Optional priority: number

    Returns any

off

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

  • Parameters

    • eventMap: EventMap | undefined
    • Optional context: any

    Returns any

  • Parameters

    • name: string | undefined
    • Optional callback: EventCallback
    • Optional context: any

    Returns 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
  • Parameters

    • eventMap: EventMap
    • Optional context: any

    Returns any

  • Parameters

    • eventMap: EventMap
    • Optional callback: EventCallback
    • Optional context: any
    • Optional priority: number

    Returns any

  • Parameters

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

    Returns any

Private onDeclaration

  • onDeclaration(context: Context, reflection: Reflection, node?: Node): void

once

  • once(eventMap: EventMap, context?: any): any
  • once(name: string, callback: EventCallback, context?: any, priority?: any): any
  • Parameters

    • eventMap: EventMap
    • Optional context: any

    Returns any

  • Parameters

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

    Returns any

stopListening

  • stopListening(obj?: EventDispatcher, name?: EventMap | string, callback?: EventCallback): this
  • Parameters

    • Optional obj: EventDispatcher
    • Optional name: EventMap | string
    • Optional callback: EventCallback

    Returns this

trigger

  • trigger(name: Event | EventMap | string, ...args: any[]): this
  • Parameters

    • name: Event | EventMap | string
    • Rest ...args: any[]

    Returns this