Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Container

Hierarchy

  • Container
    • Container

Implements

  • Container

Index

Constructors

Protected constructor

  • new Container(containerOptions?: ContainerOptions): Container
  • Parameters

    • Optional containerOptions: ContainerOptions

    Returns Container

Properties

guid

guid: string

options

options: ContainerOptions

parent

parent: Container | null

Static Protected instance

instance: Container

Methods

applyCustomMetadataReader

  • applyCustomMetadataReader(metadataReader: MetadataReader): void
  • Parameters

    • metadataReader: MetadataReader

    Returns void

applyMiddleware

  • applyMiddleware(...middlewares: Middleware[]): void
  • Parameters

    • Rest ...middlewares: Middleware[]

    Returns void

bind

  • bind<T>(serviceIdentifier: interfaces.ServiceIdentifier<T>): BindingToSyntax<T>
  • Type parameters

    • T

    Parameters

    • serviceIdentifier: interfaces.ServiceIdentifier<T>

    Returns BindingToSyntax<T>

bindTo

  • Parameters

    Returns function

      • (target: any): any
      • Parameters

        • target: any

        Returns any

build

  • build<T>(cls: any, factoryMethod?: function): T
  • Create an instance of a class using the container, making it injectable at runtime and able to @inject on the fly

    Type parameters

    • T

    Parameters

    • cls: any
    • Optional factoryMethod: function
        • (context: Context): any
        • Parameters

          • context: Context

          Returns any

    Returns T

constant

  • constant<T>(id: string, val: T): BindingWhenOnSyntax<Object>
  • Type parameters

    • T

    Parameters

    • id: string
    • val: T

    Returns BindingWhenOnSyntax<Object>

createChild

  • createChild(): Container
  • Returns Container

decorate

  • decorate(decorator: function | function, target: any, parameterIndex?: number): void
  • Parameters

    • decorator: function | function
    • target: any
    • Optional parameterIndex: number

    Returns void

ensureInjectable

  • ensureInjectable(cls: Function): void
  • Parameters

    • cls: Function

    Returns void

get

  • get<T>(serviceIdentifier: interfaces.ServiceIdentifier<T>): T
  • Type parameters

    • T

    Parameters

    • serviceIdentifier: interfaces.ServiceIdentifier<T>

    Returns T

getAll

  • getAll<T>(serviceIdentifier: interfaces.ServiceIdentifier<T>): T[]
  • Type parameters

    • T

    Parameters

    • serviceIdentifier: interfaces.ServiceIdentifier<T>

    Returns T[]

getAllNamed

  • getAllNamed<T>(serviceIdentifier: interfaces.ServiceIdentifier<T>, named: string | number | symbol): T[]
  • Type parameters

    • T

    Parameters

    • serviceIdentifier: interfaces.ServiceIdentifier<T>
    • named: string | number | symbol

    Returns T[]

getAllTagged

  • getAllTagged<T>(serviceIdentifier: interfaces.ServiceIdentifier<T>, key: string | number | symbol, value: any): T[]
  • Type parameters

    • T

    Parameters

    • serviceIdentifier: interfaces.ServiceIdentifier<T>
    • key: string | number | symbol
    • value: any

    Returns T[]

getNamed

  • getNamed<T>(serviceIdentifier: interfaces.ServiceIdentifier<T>, named: string | number | symbol): T
  • Type parameters

    • T

    Parameters

    • serviceIdentifier: interfaces.ServiceIdentifier<T>
    • named: string | number | symbol

    Returns T

getParentClasses

  • getParentClasses(cls: Function, classes?: Function[]): Function[]
  • Parameters

    • cls: Function
    • Default value classes: Function[] = []

    Returns Function[]

getTagged

  • getTagged<T>(serviceIdentifier: interfaces.ServiceIdentifier<T>, key: string | number | symbol, value: any): T
  • Type parameters

    • T

    Parameters

    • serviceIdentifier: interfaces.ServiceIdentifier<T>
    • key: string | number | symbol
    • value: any

    Returns T

inject

  • Parameters

    Returns function

      • (target: any, targetKey: string, index?: number | undefined): void
      • Parameters

        • target: any
        • targetKey: string
        • Optional index: number | undefined

        Returns void

injectable

  • injectable(): function
  • Returns function

      • (target: any): any
      • Parameters

        • target: any

        Returns any

isBound

  • isBound(serviceIdentifier: interfaces.ServiceIdentifier<any>): boolean
  • Parameters

    • serviceIdentifier: interfaces.ServiceIdentifier<any>

    Returns boolean

isBoundNamed

  • isBoundNamed(serviceIdentifier: interfaces.ServiceIdentifier<any>, named: string | number | symbol): boolean
  • Parameters

    • serviceIdentifier: interfaces.ServiceIdentifier<any>
    • named: string | number | symbol

    Returns boolean

isBoundTagged

  • isBoundTagged(serviceIdentifier: interfaces.ServiceIdentifier<any>, key: string | number | symbol, value: any): boolean
  • Parameters

    • serviceIdentifier: interfaces.ServiceIdentifier<any>
    • key: string | number | symbol
    • value: any

    Returns boolean

lazyInject

  • Parameters

    Returns function

      • (proto: any, key: string): void
      • Parameters

        • proto: any
        • key: string

        Returns void

load

  • load(...modules: ContainerModule[]): void
  • Parameters

    • Rest ...modules: ContainerModule[]

    Returns void

make

  • make<T>(cls: any): T
  • make binds the class in the IoC container if not already bound. then returns the bound instance

    Type parameters

    • T

    Parameters

    • cls: any

    Returns T

rebind

  • rebind<T>(serviceIdentifier: interfaces.ServiceIdentifier<T>): BindingToSyntax<T>
  • Type parameters

    • T

    Parameters

    • serviceIdentifier: interfaces.ServiceIdentifier<T>

    Returns BindingToSyntax<T>

resolve

  • resolve<T>(constructorFunction: Newable<T>): T
  • Type parameters

    • T

    Parameters

    • constructorFunction: Newable<T>

    Returns T

restore

  • restore(): void
  • Returns void

singleton

  • Parameters

    Returns void

snapshot

  • snapshot(): void
  • Returns void

unbind

  • unbind(serviceIdentifier: interfaces.ServiceIdentifier<any>): void
  • Parameters

    • serviceIdentifier: interfaces.ServiceIdentifier<any>

    Returns void

unbindAll

  • unbindAll(): void
  • Returns void

unload

  • unload(...modules: ContainerModule[]): void
  • Parameters

    • Rest ...modules: ContainerModule[]

    Returns void

Static getInstance

  • Returns Container

Static merge

  • merge(container1: Container, container2: Container): Container
  • Parameters

    • container1: Container
    • container2: Container

    Returns Container

Generated using TypeDoc