Interface ContainerFull<T>

Container interface for full functionality.

Type Parameters

T extends ContainerFull<T>

Hierarchy

ContainerRead
- ContainerFull

Implemented by

Container

Index

Properties

addScoped addSingleton addTransient clear clone get getOrFail merge remove scopeCreate scopeRenew

Properties

addScoped

addScoped: (<T>(factory, ref?) => RefSymbol<T>)

Type declaration

- <T>(factory, ref?): RefSymbol<T>
- Add scoped factory and create matching ref. If ref is given it is reused
  
  A scoped factory is only used once per scope.
  Type Parameters
  - T
  Parameters
  - factory: (() => T)
    - (): T
      
      Returns T
  - Optional ref: RefSymbol<T>
    
    reference
  Returns RefSymbol<T>
  given or newly created reference

addSingleton

addSingleton: (<T>(factory, ref?) => RefSymbol<T>)

Type declaration

- <T>(factory, ref?): RefSymbol<T>
- Add singleton factory and create matching ref. If ref is given it is reused
  
  A singleton factory is only used once and the result cached until it is cleared.
  Type Parameters
  - T
  Parameters
  - factory: (() => T)
    - (): T
      
      Returns T
  - Optional ref: RefSymbol<T>
    
    reference
  Returns RefSymbol<T>
  given or newly created reference

addTransient

addTransient: (<T>(factory, ref?) => RefSymbol<T>)

Type declaration

- <T>(factory, ref?): RefSymbol<T>
- Add transient factory and create matching ref. If ref is given it is reused
  
  A transient factory is used for every access and the result is never cached.
  Type Parameters
  - T
  Parameters
  - factory: (() => T)
    - (): T
      
      Returns T
  - Optional ref: RefSymbol<T>
    
    reference
  Returns RefSymbol<T>
  given or newly created reference

clear

clear: (<T>(ref?) => boolean)

Type declaration

- <T>(ref?): boolean
- Remove all or specific ref from container but leaves factory intact. Only relevant for singleton or scoped services
  Type Parameters
  - T
  Parameters
  - Optional ref: RefSymbol<T>
    
    reference
  Returns boolean
  true if something was removed

clone

clone: (() => T)

Type declaration

- (): T
- Create a fully independent clone of the current container
  
  Returns T
  container

get

get: (<T>(ref) => undefined | T)

Type declaration

- <T>(ref): undefined | T
- Retrieves the data from the container referenced by the given RefSymbol. If there is no data available it returns undefined but never throws an exception.
  Type Parameters
  - T
  Parameters
  - ref: RefSymbol<T>
    
    reference
  Returns undefined | T
  The referenced data from the container or undefined.

getOrFail

getOrFail: (<T>(ref) => T)

Type declaration

- <T>(ref): T
- Retrieves the data from the container referenced by the given RefSymbol. If there is no data available it throws an exception defined by the container.
  Type Parameters
  - T
  Parameters
  - ref: RefSymbol<T>
    
    reference
  Returns T
  The referenced data from the container.

merge

merge: ((...args) => void)

Type declaration

- (...args): void
- Merge two or more containers. Conflicting factories, service lifetimes and singletons are overwritten by priority, see args.
  Parameters
  - Rest ...args: T[]
    
    container, ordered descending by priority
  Returns void

remove

remove: (<T>(ref?) => boolean)

Type declaration

- <T>(ref?): boolean
- Removes all or specific ref from container which includes the factory.
  Type Parameters
  - T
  Parameters
  - Optional ref: RefSymbol<T>
    
    reference
  Returns boolean
  true if something was removed

scopeCreate

scopeCreate: (() => T)

Type declaration

- (): T
- Creates separate scope from the current container. Data except scope is shared between copy and original object.
  
  Returns T
  container

scopeRenew

scopeRenew: (() => void)

Type declaration

- (): void
- Renews scope of current container.
  
  Returns void

Generated using TypeDoc