Class FactoryBindContext<M, T, F>

Factory bind context. Used to define aliases, exports and other stuff for current factory.

Type Parameters

M extends Module = Module
T = any
F extends ISyncFactory<T> | IAsyncFactory<T> = ISyncFactory<T> | IAsyncFactory<T>

Index

Constructors

Properties

factory key module

Methods

alias export getFactory getKey getModule tap tapAsync tapFactory tapFactoryAsync

Constructors

constructor

new FactoryBindContext<M, T, F>(module, key, factory): FactoryBindContext<M, T, F>
Type Parameters
- M extends Module<any> = Module<any>
- T = any
- F extends ISyncFactory<T, Module<any>> | IAsyncFactory<T, Module<any>> = ISyncFactory<T, Module<any>> | IAsyncFactory<T, Module<any>>
Parameters
- module: M
- key: TBindKey
- factory: F
Returns FactoryBindContext<M, T, F>
- Defined in packages/core/src/factory/FactoryBindContext.ts:15

Properties

`Protected` factory

factory: F

`Protected` key

`Protected` module

module: M

Methods

alias

alias(aliasKey): FactoryBindContext<M, T, F>
Adding an alias for current factory.
Parameters
- aliasKey: TBindKey | TBindKey[]
Returns FactoryBindContext<M, T, F>
- Defined in packages/core/src/factory/FactoryBindContext.ts:52

export

export(opts?): FactoryBindContext<M, T, F>
Exports current factory. Can be used to export all aliases of this binding or/and mark it as global export.
Parameters
- Optional opts: {
  global?: boolean;
  withAliases?: boolean;
  }
  - Optional global?: boolean
  - Optional withAliases?: boolean
Returns FactoryBindContext<M, T, F>
- Defined in packages/core/src/factory/FactoryBindContext.ts:27

getFactory

getFactory(): F
Returns F
- Defined in packages/core/src/factory/FactoryBindContext.ts:68

getKey

getKey(): TBindKey
Returns TBindKey
- Defined in packages/core/src/factory/FactoryBindContext.ts:64

getModule

getModule(): M
Returns M
- Defined in packages/core/src/factory/FactoryBindContext.ts:90

tap

tap(func): FactoryBindContext<M, T, F>
Runs a function with current context.
Parameters
- func: ((context) => unknown)
  - - (context): unknown
    - Parameters
      context: this
      Returns unknown
Returns FactoryBindContext<M, T, F>
- Defined in packages/core/src/factory/FactoryBindContext.ts:98

tapAsync

tapAsync(func): Promise<FactoryBindContext<M, T, F>>
Runs an async function with current context.
Parameters
- func: ((context) => Promise<unknown>)
  - - (context): Promise<unknown>
    - Parameters
      context: this
      Returns Promise<unknown>
Returns Promise<FactoryBindContext<M, T, F>>
- Defined in packages/core/src/factory/FactoryBindContext.ts:107

tapFactory

tapFactory(func): FactoryBindContext<M, T, F>
Runs a function with current factory.
Parameters
- func: ((factory) => unknown)
  - - (factory): unknown
    - Parameters
      factory: F
      Returns unknown
Returns FactoryBindContext<M, T, F>
- Defined in packages/core/src/factory/FactoryBindContext.ts:76

tapFactoryAsync

tapFactoryAsync(func): Promise<FactoryBindContext<M, T, F>>
Runs an async function with current factory.
Parameters
- func: ((factory) => Promise<unknown>)
  - - (factory): Promise<unknown>
    - Parameters
      factory: F
      Returns Promise<unknown>
Returns Promise<FactoryBindContext<M, T, F>>
- Defined in packages/core/src/factory/FactoryBindContext.ts:85