Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ReferenceConverter

Hierarchy

Implements

Index

Constructors

constructor

Properties

componentName

componentName: string

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

priority

priority: number = -50

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

Accessors

application

owner

Methods

Protected bubble

Private convertLiteral

  • convertLiteral(context: Context, symbol: Symbol, node?: Node): Type
  • Create a type literal reflection.

    This is a utility function used by [[convertTypeReferenceNode]] and [[convertTypeReferenceType]] when encountering an object or type literal.

    A type literal is explicitly set:

    let someValue: {a: string; b: number;};
    

    An object literal types are usually reflected by the TypeScript compiler:

    function someFunction() { return {a: 'Test', b: 1024}; }
    

    Parameters

    • context: Context

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

    • symbol: Symbol

      The symbol describing the type literal.

    • Optional node: Node

      If known the node which produced the type literal. Type literals that are implicitly generated by TypeScript won't have a corresponding node.

    Returns Type

    A type reflection representing the given type literal.

convertNode

  • convertNode(context: Context, node: TypeReferenceNode, type: TypeReference): Type
  • Convert the type reference node to its type reflection.

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

    class SomeClass { }
    let someValue: SomeClass;
    

    Parameters

    • context: Context

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

    • node: TypeReferenceNode

      The type reference node that should be converted.

    • type: TypeReference

      The type of the type reference node.

    Returns Type

    The type reflection representing the given reference 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

stopListening

supportsNode

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

    Parameters

    • context: Context
    • node: TypeReferenceNode
    • type: TypeReference

    Returns boolean

supportsType

  • supportsType(context: Context, type: TypeReference): 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