Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "decorators"

Index

Variables

Const KEY_INJECT

KEY_INJECT: "inject:key_inject" = "inject:key_inject"

Const KEY_INJECT_CLASS

KEY_INJECT_CLASS: "inject:key_inject_class" = "inject:key_inject_class"

Const KEY_INJECT_META_PARAM

KEY_INJECT_META_PARAM: "inject:meta:provide_param" = "inject:meta:provide_param"

Const KEY_INJECT_PARAMETERS

KEY_INJECT_PARAMETERS: "inject:method_inject_parameters" = "inject:method_inject_parameters"

Const KEY_NAMESPACE

KEY_NAMESPACE: "inject:namespace" = "inject:namespace"

Const KEY_NO_WRAP

KEY_NO_WRAP: "inject:no_wrap" = "inject:no_wrap"

Const KEY_PARAMETER_NO_WRAP

KEY_PARAMETER_NO_WRAP: "inject:parameter:no_wrap" = "inject:parameter:no_wrap"

Const KEY_PROVIDE

KEY_PROVIDE: "inject:provide" = "inject:provide"

Const KEY_REQUIRED

KEY_REQUIRED: "inject:required_parameter" = "inject:required_parameter"

Const KEY_TRANSIENT

KEY_TRANSIENT: "inject:class:transient" = "inject:class:transient"

Const decoratorLogger

decoratorLogger: Debugger = createLogger("decorator")

Const withType

withType: provider = provider

alias of @provider decorator

Functions

createInjectDecorator

  • createInjectDecorator(type?: LazyRef): (target: any, targetKey: any, parameterIndex?: any) => void
  • createInjectDecorator(type: any): (target: any, targetKey: any, parameterIndex?: any) => void
  • create a new decorator for inject specific type

    Parameters

    Returns (target: any, targetKey: any, parameterIndex?: any) => void

      • (target: any, targetKey: any, parameterIndex?: any): void
      • Parameters

        • target: any
        • targetKey: any
        • Optional parameterIndex: any

        Returns void

  • Parameters

    • type: any

    Returns (target: any, targetKey: any, parameterIndex?: any) => void

      • (target: any, targetKey: any, parameterIndex?: any): void
      • Parameters

        • target: any
        • targetKey: any
        • Optional parameterIndex: any

        Returns void

getClassConstructorParams

  • get the parameters metadata of the constructor of class

    Parameters

    Returns InjectParameter[]

getClassInjectionInformation

  • Parameters

    • target: any

    Returns Map<string, InjectInformation>

getClassMethodParams

  • Parameters

    • target: any
    • targetKey: any

    Returns InjectParameter[]

getInjectParameter

  • getInjectParameter(target: any, targetKey?: any, parameterIndexOrDesc?: any): any
  • Parameters

    • target: any
    • Optional targetKey: any
    • Optional parameterIndexOrDesc: any

    Returns any

getNamespace

  • getNamespace(target: Class): string
  • getNamespace(target: any): string
  • get namespace for class

    Parameters

    Returns string

  • get namespace for instance

    Parameters

    • target: any

    Returns string

getPropertyInjectedType

  • getPropertyInjectedType(target: any, targetKey: any): any
  • get @inject type of the property of the class instance

    Parameters

    • target: any
    • targetKey: any

    Returns any

getProvideInfo

  • getProvideInfo(target: any, targetKey?: any): any
  • get provide type information

    Parameters

    • target: any
    • Optional targetKey: any

    Returns any

getTransientInfo

  • getTransientInfo(target: any, targetKey: any): boolean
  • get transient information

    Parameters

    • target: any
    • targetKey: any

    Returns boolean

getUnProxyTarget

  • objects will wrapped by IoC Container, use this function get the original object

    Type parameters

    Parameters

    Returns T

  • Type parameters

    Parameters

    • target: T

    Returns T

inject

  • inject(type: LazyRef): ParameterDecorator & PropertyDecorator
  • inject(type: Class): ParameterDecorator & PropertyDecorator
  • inject(type: string): ParameterDecorator & PropertyDecorator
  • inject(): PropertyDecorator
  • inject parameter

    Parameters

    Returns ParameterDecorator & PropertyDecorator

  • Parameters

    Returns ParameterDecorator & PropertyDecorator

  • Parameters

    • type: string

    Returns ParameterDecorator & PropertyDecorator

  • Returns PropertyDecorator

isNoWrap

  • isNoWrap(classType: any): any
  • isNoWrap(target: any, propertyName: string): any
  • isNoWrap(target: any, methodName: any, parameterIndex: number): any
  • Parameters

    • classType: any

    Returns any

  • Parameters

    • target: any
    • propertyName: string

    Returns any

  • Parameters

    • target: any
    • methodName: any
    • parameterIndex: number

    Returns any

isNoWrapProvider

  • isNoWrapProvider(provider: any): any
  • Parameters

    • provider: any

    Returns any

isProviderInstance

  • isProviderInstance(target: any): target is InstanceProvider
  • Parameters

    • target: any

    Returns target is InstanceProvider

isProviderType

  • isProviderType(target: any): target is Class<InstanceProvider>
  • Parameters

    • target: any

    Returns target is Class<InstanceProvider>

isRequired

  • isRequired(target: any, targetKey: any, parameterIndex?: any): boolean
  • Parameters

    • target: any
    • targetKey: any
    • Optional parameterIndex: any

    Returns boolean

isTransient

  • isTransient(target: any, targetKey?: any): boolean
  • Parameters

    • target: any
    • Optional targetKey: any

    Returns boolean

isWrappedFunction

  • isWrappedFunction(target: any): target is { [WRAPPED_OBJECT_METHOD_ORIGINAL_METHOD]: any }
  • Parameters

    • target: any

    Returns target is { [WRAPPED_OBJECT_METHOD_ORIGINAL_METHOD]: any }

isWrappedObject

  • isWrappedObject(target: any): target is { [WRAPPED_ORIGINAL_OBJECT_PROPERTY]: any }
  • Parameters

    • target: any

    Returns target is { [WRAPPED_ORIGINAL_OBJECT_PROPERTY]: any }

lazyRef

  • lazyRef<T>(type: () => T): LazyRef<T>
  • alias

    LazyRef.create

    Type parameters

    • T

    Parameters

    • type: () => T
        • (): T
        • Returns T

    Returns LazyRef<T>

namespace

  • namespace(nSpace: string): (Anonymous function)
  • Parameters

    • nSpace: string

    Returns (Anonymous function)

noWrap

  • noWrap(target: any, targetKey?: any, parameterIndex?: any): void
  • disable wrapper for provider type/class instance

    Parameters

    • target: any
    • Optional targetKey: any
    • Optional parameterIndex: any

    Returns void

param

  • param(key: string, value: any): (Anonymous function)
  • provide param (name: value) to provider

    Parameters

    • key: string
    • value: any

    Returns (Anonymous function)

provider

  • provider(type?: LazyRef): (target: any, targetKey?: any) => void
  • provider(type?: string): (target: any, targetKey?: any) => void
  • provider(type?: Class): (target: any, targetKey?: any) => void
  • Parameters

    Returns (target: any, targetKey?: any) => void

      • (target: any, targetKey?: any): void
      • Parameters

        • target: any
        • Optional targetKey: any

        Returns void

  • Parameters

    • Optional type: string

    Returns (target: any, targetKey?: any) => void

      • (target: any, targetKey?: any): void
      • Parameters

        • target: any
        • Optional targetKey: any

        Returns void

  • Parameters

    Returns (target: any, targetKey?: any) => void

      • (target: any, targetKey?: any): void
      • Parameters

        • target: any
        • Optional targetKey: any

        Returns void

required

  • required(target: any, targetKey: any): any
  • required(target: any, targetKey: any, parameterIndex: any): any
  • Parameters

    • target: any
    • targetKey: any

    Returns any

  • Parameters

    • target: any
    • targetKey: any
    • parameterIndex: any

    Returns any

setClassConstructorParams

  • Parameters

    Returns void

setClassInjectInformation

  • setClassInjectInformation(target: any, info: any): void
  • Parameters

    • target: any
    • info: any

    Returns void

setClassMethodParameter

  • setClassMethodParameter(target: any, targetKey: any, param: InjectParameter): void
  • Parameters

    Returns void

setClassMethodParams

  • setClassMethodParams(target: any, targetKey: any, params: InjectParameter[]): void
  • Parameters

    Returns void

transient

  • transient(target: Class): void
  • transient(target: any, targetKey: any): void
  • transient provider, inject container will not cache it

    Parameters

    Returns void

  • transient type, inject container will not cache it

    Parameters

    • target: any
    • targetKey: any

    Returns void

Generated using TypeDoc