Class UmbContextProviderController<BaseType, ResultType, InstanceType>

UmbContextProvider

Type Parameters

BaseType extends UmbContextMinimal = UmbContextMinimal
ResultType extends BaseType = BaseType
InstanceType extends ResultType = ResultType

Hierarchy (View Summary, Expand)

UmbContextProvider<BaseType, ResultType>
- UmbContextProviderController

Implements

UmbController

Index

Constructors

Accessors

controllerAlias

Methods

destroy hostConnected hostDisconnected providerInstance

Constructors

constructor

new UmbContextProviderController<
    BaseType extends UmbContextMinimal = UmbContextMinimal,
    ResultType extends UmbContextMinimal = BaseType,
    InstanceType extends UmbContextMinimal = ResultType,
>(
    host: UmbControllerHost,
    contextAlias: string | UmbContextToken<BaseType, ResultType>,
    instance: InstanceType,
): UmbContextProviderController<BaseType, ResultType, InstanceType>
Type Parameters
- BaseType extends UmbContextMinimal = UmbContextMinimal
- ResultType extends UmbContextMinimal = BaseType
- InstanceType extends UmbContextMinimal = ResultType
Parameters
- host: UmbControllerHost
- contextAlias: string | UmbContextToken<BaseType, ResultType>
- instance: InstanceType
Returns UmbContextProviderController<BaseType, ResultType, InstanceType>
Overrides UmbContextProvider.constructor
- Defined in src/libs/context-api/provide/context-provider.controller.ts:21

Accessors

controllerAlias

get controllerAlias(): string
Returns string
Implementation of UmbController.controllerAlias
- Defined in src/libs/context-api/provide/context-provider.controller.ts:17

Methods

destroy

destroy(): void
Returns void
Implementation of UmbController.destroy
Overrides UmbContextProvider.destroy
- Defined in src/libs/context-api/provide/context-provider.controller.ts:50

hostConnected

hostConnected(): void
Returns void
Memberof
UmbContextProvider
Implementation of UmbController.hostConnected
Inherited from UmbContextProvider.hostConnected
- Defined in src/libs/context-api/provide/context-provider.ts:55

hostDisconnected

hostDisconnected(): void
Returns void
Memberof
UmbContextProvider
Implementation of UmbController.hostDisconnected
Inherited from UmbContextProvider.hostDisconnected
- Defined in src/libs/context-api/provide/context-provider.ts:65

providerInstance

providerInstance(): unknown
Method to enable comparing the context providers by the instance they provide. Note this method should have a unique name for the provider controller, for it not to be confused with a consumer.

Returns unknown
Inherited from UmbContextProvider.providerInstance
- Defined in src/libs/context-api/provide/context-provider.ts:28