Class Igpapi`Abstract`

Hierarchy

Igpapi

Index

Constructors

`Protected`constructor

new Igpapi(): Igpapi
Returns Igpapi

Properties

container

container: ContainerInstance = ...

resolve

resolve: {
    <T>(type: Constructable<T>): T;
    <T>(type: AbstractConstructable<T>): T;
    <T>(id: string): T;
    <T>(id: Token<T>): T;
    <T>(id: ServiceIdentifier<T>): T;
} = ...

Type declaration

- <T>(type: Constructable<T>): T
- Retrieves the service with given name or type from the service container. Optionally, parameters can be passed in case if instance is initialized in the container for the first time.
  Type Parameters
  - T
  Parameters
  - type: Constructable<T>
  Returns T
- <T>(type: AbstractConstructable<T>): T
- Type Parameters
  - T
  Parameters
  - type: AbstractConstructable<T>
  Returns T
- <T>(id: string): T
- Type Parameters
  - T
  Parameters
  - id: string
  Returns T
- <T>(id: Token<T>): T
- Type Parameters
  - T
  Parameters
  - id: Token<T>
  Returns T
- <T>(id: ServiceIdentifier<T>): T
- Type Parameters
  - T
  Parameters
  - id: ServiceIdentifier<T>
  Returns T

set

set: {
    <T>(service: ServiceMetadata<T>): this;
    <T>(type: Constructable<T>, instance: T): this;
    <T>(type: AbstractConstructable<T>, instance: T): this;
    <T>(name: string, instance: T): this;
    <T>(token: Token<T>, instance: T): this;
    <T>(token: ServiceIdentifier, instance: T): this;
    <T>(metadata: ServiceOptions<T>): this;
    <T>(metadataArray: ServiceOptions<T>[]): this;
} = ...

Type declaration

- <T>(service: ServiceMetadata<T>): this
- Sets a value for the given type or service name in the container.
  Type Parameters
  - T = unknown
  Parameters
  - service: ServiceMetadata<T>
  Returns this
- <T>(type: Constructable<T>, instance: T): this
- Type Parameters
  - T = unknown
  Parameters
  - type: Constructable<T>
  - instance: T
  Returns this
- <T>(type: AbstractConstructable<T>, instance: T): this
- Type Parameters
  - T = unknown
  Parameters
  - type: AbstractConstructable<T>
  - instance: T
  Returns this
- <T>(name: string, instance: T): this
- Type Parameters
  - T = unknown
  Parameters
  - name: string
  - instance: T
  Returns this
- <T>(token: Token<T>, instance: T): this
- Type Parameters
  - T = unknown
  Parameters
  - token: Token<T>
  - instance: T
  Returns this
- <T>(token: ServiceIdentifier, instance: T): this
- Type Parameters
  - T = unknown
  Parameters
  - token: ServiceIdentifier
  - instance: T
  Returns this
- <T>(metadata: ServiceOptions<T>): this
- Type Parameters
  - T = unknown
  Parameters
  - metadata: ServiceOptions<T>
  Returns this
- <T>(metadataArray: ServiceOptions<T>[]): this
- Type Parameters
  - T = unknown
  Parameters
  - metadataArray: ServiceOptions<T>[]
  Returns this

`Abstract` `Readonly`state

state: IgpapiState

Accessors

command

get command(): IgpapiCommandInvoker
Returns IgpapiCommandInvoker

execute

get execute(): (<T extends ICommand>(cls: Cls<T>, input?: IgpapiFactoryInput<T>) => ReturnType<T["execute"]>)
Returns (<T extends ICommand>(cls: Cls<T>, input?: IgpapiFactoryInput<T>) => ReturnType<T["execute"]>)
- - <T extends ICommand>(cls: Cls<T>, input?: IgpapiFactoryInput<T>): ReturnType<T["execute"]>
  - Type Parameters
    - T extends ICommand
    Parameters
    - cls: Cls<T>
    - Optionalinput: IgpapiFactoryInput<T>
    Returns ReturnType<T["execute"]>

factory

get factory(): IgpapiFactory
Returns IgpapiFactory

instantiate

get instantiate(): (<T>(cls: Cls<T>, input?: IgpapiFactoryInput<T>) => T)
Returns (<T>(cls: Cls<T>, input?: IgpapiFactoryInput<T>) => T)
- - <T>(cls: Cls<T>, input?: IgpapiFactoryInput<T>): T
  - Type Parameters
    - T
    Parameters
    - cls: Cls<T>
    - Optionalinput: IgpapiFactoryInput<T>
    Returns T

mqtt

get mqtt(): IgpapiMqtt
Returns IgpapiMqtt

request

get request(): IgpapiRequestInvoker
Returns IgpapiRequestInvoker

Methods

`Protected`initHttp

initHttp(Http: Constructor<IgpapiHttp>): void
Parameters
- Http: Constructor<IgpapiHttp>
Returns void

`Protected`initState

initState(ConcreteState: Constructor<IgpapiState>, input?: any): void
Parameters
- ConcreteState: Constructor<IgpapiState>
- Optionalinput: any
Returns void

Class IgpapiAbstract

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Protectedconstructor

Returns Igpapi

Properties

container

resolve

Type declaration

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns T

set

Type declaration

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

Abstract Readonlystate

Accessors

command

Returns IgpapiCommandInvoker

execute

Returns (<T extends ICommand>(cls: Cls<T>, input?: IgpapiFactoryInput<T>) => ReturnType<T["execute"]>)

Type Parameters

Parameters

Returns ReturnType<T["execute"]>

factory

Returns IgpapiFactory

instantiate

Returns (<T>(cls: Cls<T>, input?: IgpapiFactoryInput<T>) => T)

Type Parameters

Parameters

Returns T

mqtt

Returns IgpapiMqtt

request

Returns IgpapiRequestInvoker

Methods

ProtectedinitHttp

Parameters

Returns void

ProtectedinitState

Class Igpapi`Abstract`

`Protected`constructor

`Abstract` `Readonly`state

`Protected`initHttp

`Protected`initState