Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ArrayConverter

Hierarchy

Implements

Index

Constructors

constructor

Properties

componentName

componentName: string

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

priority

priority: number = 0

The priority this converter should be executed with. A higher priority means the converter will be applied earlier.

Accessors

application

owner

Methods

Protected bubble

convertNode

  • convertNode(context: Context, node: ArrayTypeNode): Type
  • Convert the given array type node to its type reflection.

    This is a node based converter with no type equivalent.

    let someValue: number[];
    

    Parameters

    • context: Context

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

    • node: ArrayTypeNode

      The array type node that should be converted.

    Returns Type

    The type reflection representing the given array type node.

convertType

  • convertType(context: Context, type: TypeReference): Type
  • Convert the given type reference to its type reflection.

    This is a type based converter, see [[convertTypeReference]] for the node equivalent.

    class SomeClass { }
    let someValue: SomeClass;
    

    Parameters

    • context: Context

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

    • type: TypeReference

      The type reference that should be converted.

    Returns Type

    The type reflection representing the given type reference.

getOptionDeclarations

Protected 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

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

supportsNode

  • supportsNode(context: Context, node: ArrayTypeNode): boolean
  • Test whether this converter can handle the given TypeScript node.

    Parameters

    • context: Context
    • node: ArrayTypeNode

    Returns boolean

supportsType

  • supportsType(context: Context, type: TypeReference): boolean
  • Test whether this converter can handle the given TypeScript type.

    Parameters

    • context: Context
    • type: TypeReference

    Returns boolean

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