Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ModuleAnnotation

Hierarchy

  • Annotation
    • ModuleAnnotation

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly $metadataName

$metadataName: string

imports

imports: ModuleLike[]

Modules imported by this module

Readonly ngMetadataName

ngMetadataName: string

providers

providers: Provider[]

Dependency injection providers

tasks

tasks: any[]

Task classes which are part of this module

deprecated

Methods

applyToClass

  • applyToClass(target: any): this

  • Apply this annotation to a given target.

    Parameters

    • target: any

    Returns this

applyToConstructorParameter

  • applyToConstructorParameter(target: any, index: number): this

  • Apply this annotation instance to the given constructor parameter.

    Parameters

    • target: any
    • index: number

    Returns this

applyToMethod

  • applyToMethod(target: any, name: string): this

  • Apply this annotation instance to the given method.

    Parameters

    • target: any
    • name: string

    Returns this

applyToParameter

  • applyToParameter(target: any, name: string, index: number): this

  • Apply this annotation instance to the given method parameter.

    Parameters

    • target: any
    • name: string
    • index: number

    Returns this

applyToProperty

  • applyToProperty(target: any, name: string): this

  • Apply this annotation instance to the given property.

    Parameters

    • target: any
    • name: string

    Returns this

clone

  • clone(): this

  • Clone this annotation instance into a new one. This is not a deep copy.

    Returns this

toString

  • toString(): string

  • Returns string

Static decorator

  • decorator<T, TS>(this: AnnotationConstructor<T, TS>, options?: AnnotationDecoratorOptions<T, TS>): AnnotationDecorator<TS>

  • Construct a decorator suitable for attaching annotations of the called type onto classes, constructor parameters, methods, properties, and parameters. Must be called while referencing the subclass of Annotation you wish to construct the decorator for. E.g., for FooAnnotation, call FooAnnotation.decorator().

    Type parameters

    • T: Annotation

    • TS: any[]

    Parameters

    • this: AnnotationConstructor<T, TS>

      The Annotation subclass for which the decorator is being constructed

    • Optional options: AnnotationDecoratorOptions<T, TS>

      Allows for specifying options which will modify the behavior of the decorator. See the DecoratorOptions documentation for more information.

    Returns AnnotationDecorator<TS>

Static filter

  • filter<T, TS>(this: AnnotationConstructor<T, TS>, annotations: IAnnotation[]): T[]

  • Type parameters

    • T: Annotation

    • TS: any[]

    Parameters

    • this: AnnotationConstructor<T, TS>
    • annotations: IAnnotation[]

    Returns T[]

Static getAllForClass

  • getAllForClass<T, TS>(this: AnnotationConstructor<T, TS>, type: any): T[]

  • Type parameters

    • T: Annotation

    • TS: any[]

    Parameters

    • this: AnnotationConstructor<T, TS>
    • type: any

    Returns T[]

Static getAllForConstructorParameters

  • getAllForConstructorParameters<T, TS>(this: AnnotationConstructor<T, TS>, type: any): T[][]

  • Type parameters

    • T: Annotation

    • TS: any[]

    Parameters

    • this: AnnotationConstructor<T, TS>
    • type: any

    Returns T[][]

Static getAllForMethod

  • getAllForMethod<T, TS>(this: AnnotationConstructor<T, TS>, type: any, methodName: string): T[]

  • Type parameters

    • T: Annotation

    • TS: any[]

    Parameters

    • this: AnnotationConstructor<T, TS>
    • type: any
    • methodName: string

    Returns T[]

Static getAllForParameters

  • getAllForParameters<T, TS>(this: AnnotationConstructor<T, TS>, type: any, methodName: string): T[][]

  • Type parameters

    • T: Annotation

    • TS: any[]

    Parameters

    • this: AnnotationConstructor<T, TS>
    • type: any
    • methodName: string

    Returns T[][]

Static getAllForProperty

  • getAllForProperty<T, TS>(this: AnnotationConstructor<T, TS>, type: any, propertyName: string): T[]

  • Type parameters

    • T: Annotation

    • TS: any[]

    Parameters

    • this: AnnotationConstructor<T, TS>
    • type: any
    • propertyName: string

    Returns T[]

Static getForClass

  • getForClass<T, TS>(this: AnnotationConstructor<T, TS>, type: any): T

  • Type parameters

    • T: Annotation

    • TS: any[]

    Parameters

    • this: AnnotationConstructor<T, TS>
    • type: any

    Returns T

Static getForMethod

  • getForMethod<T, TS>(this: AnnotationConstructor<T, TS>, type: any, methodName: string): T

  • Type parameters

    • T: Annotation

    • TS: any[]

    Parameters

    • this: AnnotationConstructor<T, TS>
    • type: any
    • methodName: string

    Returns T

Static getForProperty

  • getForProperty<T, TS>(this: AnnotationConstructor<T, TS>, type: any, propertyName: string): T

  • Type parameters

    • T: Annotation

    • TS: any[]

    Parameters

    • this: AnnotationConstructor<T, TS>
    • type: any
    • propertyName: string

    Returns T

Static getMetadataName

  • getMetadataName(): string

Generated using TypeDoc