Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CategoryPlugin

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

The handler sets the ┬┤category┬┤ property of all reflections.

Hierarchy

Implements

Index

Constructors

constructor

Properties

categorizeByGroup

categorizeByGroup: boolean

categoryOrder

categoryOrder: string[]

componentName

componentName: string

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

defaultCategory

defaultCategory: string

Static WEIGHTS

WEIGHTS: string[] = []

Static defaultCategory

defaultCategory: string = "Other"

Accessors

application

owner

Methods

Protected bubble

Private categorize

getOptionDeclarations

Private groupCategorize

initialize

  • initialize(): void

listenTo

listenToOnce

Private lumpCategorize

off

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

on

  • on(eventMap: EventMap, context?: any): any
  • on(eventMap: EventMap, callback?: EventCallback, context?: any, priority?: undefined | number): any
  • on(name: string, callback: EventCallback, context?: any, priority?: undefined | number): any

Private onBegin

Private onEndResolve

  • onEndResolve(context: Context): 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 getCategory

Static getReflectionCategories

Static sortCatCallback

Generated using TypeDoc