Class UmbContextProvider<BaseType, ResultType>

UmbContextProvider

Type Parameters

BaseType extends UmbContextMinimal = UmbContextMinimal
ResultType extends BaseType = BaseType

Hierarchy (View Summary)

UmbContextProvider
- UmbContextProviderController

Index

Constructors

Methods

destroy hostConnected hostDisconnected providerInstance

Constructors

constructor

new UmbContextProvider<
    BaseType extends UmbContextMinimal = UmbContextMinimal,
    ResultType extends UmbContextMinimal = BaseType,
>(
    eventTarget: EventTarget,
    contextIdentifier: string | UmbContextToken<BaseType, ResultType>,
    instance: ResultType,
): UmbContextProvider<BaseType, ResultType>
Creates an instance of UmbContextProvider.
Type Parameters
- BaseType extends UmbContextMinimal = UmbContextMinimal
- ResultType extends UmbContextMinimal = BaseType
Parameters
- eventTarget: EventTarget
  the host element for this context provider
- contextIdentifier: string | UmbContextToken<BaseType, ResultType>
  a string or token to identify the context
- instance: ResultType
  the instance to provide
Returns UmbContextProvider<BaseType, ResultType>
Memberof
UmbContextProvider
- Defined in src/libs/context-api/provide/context-provider.ts:39

Methods

destroy

destroy(): void
Returns void
- Defined in src/libs/context-api/provide/context-provider.ts:111

hostConnected

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

hostDisconnected

hostDisconnected(): void
Returns void
Memberof
UmbContextProvider
- 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
- Defined in src/libs/context-api/provide/context-provider.ts:28