Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GroupPlugin

A handler that sorts and groups the found reflections in the resolving phase.

The handler sets the ´groups´ property of all reflections.

Hierarchy

Implements

Index

Constructors

constructor

Properties

componentName

componentName: string

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

Static PLURALS

PLURALS: object = (function() {const plurals = {};plurals[ReflectionKind.Class] = 'Classes';plurals[ReflectionKind.Property] = 'Properties';plurals[ReflectionKind.Enum] = 'Enumerations';plurals[ReflectionKind.EnumMember] = 'Enumeration members';plurals[ReflectionKind.TypeAlias] = 'Type aliases';return plurals;})()

Define the plural name of individual reflection kinds.

Type declaration

Static SINGULARS

SINGULARS: object = (function() {const singulars = {};singulars[ReflectionKind.Enum] = 'Enumeration';singulars[ReflectionKind.EnumMember] = 'Enumeration member';return singulars;})()

Define the singular name of individual reflection kinds.

Type declaration

Static WEIGHTS

WEIGHTS: ReflectionKind[] = [ReflectionKind.Global,ReflectionKind.ExternalModule,ReflectionKind.Module,ReflectionKind.Enum,ReflectionKind.EnumMember,ReflectionKind.Class,ReflectionKind.Interface,ReflectionKind.TypeAlias,ReflectionKind.Constructor,ReflectionKind.Event,ReflectionKind.Property,ReflectionKind.Variable,ReflectionKind.Function,ReflectionKind.Accessor,ReflectionKind.Method,ReflectionKind.ObjectLiteral,ReflectionKind.Parameter,ReflectionKind.TypeParameter,ReflectionKind.TypeLiteral,ReflectionKind.CallSignature,ReflectionKind.ConstructorSignature,ReflectionKind.IndexSignature,ReflectionKind.GetSignature,ReflectionKind.SetSignature]

Define the sort order of reflections.

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

Private onResolve

  • Triggered when the converter resolves a reflection.

    Parameters

    • context: Context

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

    • reflection: Reflection

      The reflection that is currently resolved.

    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

Static getKindPlural

  • Return the plural name of a internal typescript kind identifier.

    Parameters

    • kind: ReflectionKind

      The original internal typescript kind identifier.

    Returns string

    The plural name of the given internal typescript kind identifier

Static getKindSingular

  • Return the singular name of a internal typescript kind identifier.

    Parameters

    • kind: ReflectionKind

      The original internal typescript kind identifier.

    Returns string

    The singular name of the given internal typescript kind identifier

Static Private getKindString

  • Transform the internal typescript kind identifier into a human readable version.

    Parameters

    Returns string

    A human readable version of the given typescript kind identifier.

Static getReflectionGroups

  • Create a grouped representation of the given list of reflections.

    Reflections are grouped by kind and sorted by weight and name.

    Parameters

    • reflections: Reflection[]

      The reflections that should be grouped.

    Returns ReflectionGroup[]

    An array containing all children of the given reflection grouped by their kind.

Static sortCallback

Generated using TypeDoc