GatewayInversionBuilder

The builder injects a Gateway in Custom Elements.

Type parameters

E: HTMLElement

the type of the Custom Element

Hierarchy

AbstractGatewayBuilder<E>
- GatewayInversionBuilder

Index

Constructors

constructor

Properties

Methods

Constructors

Protected constructor

new GatewayInversionBuilder<E>(_propName?: string, _key?: RegistryKey, _provider?: ContainerProvider): GatewayInversionBuilder<E>

Overrides AbstractGatewayBuilder<E>.constructor
- Defined in packages/ceb-messaging-builder-inversion/src/builder.ts:26
internal
Type parameters
- E: HTMLElement
Parameters
- _propName: string = "gateway"
- _key: RegistryKey = GatewaySymbol
- Optional _provider: ContainerProvider
Returns GatewayInversionBuilder<E>

Properties

Protected _gatewayProvider

_gatewayProvider: GatewayProvider

_propName

_propName: string

internal

Protected _subscriptionsByType

_subscriptionsByType: Map<string, [ElementSubscriptionListener<HTMLElement, Event<any, MessageHeaders>>, undefined | SubscribeOptions][]>

Static Private DEFAULT_CONTAINER

DEFAULT_CONTAINER: Container

Methods

Protected build

build(Constructor: CustomElementConstructor<E>, hooks: HooksRegistration<E & { __ceb_gateway_subscriptions: Set<Removable> }>): void

Inherited from AbstractGatewayBuilder.build
- Defined in packages/ceb-messaging-builder-core/dist/types/builder.d.ts:113
This API is dedicated for developer of Builders.

Parameters
- Constructor: CustomElementConstructor<E>
- hooks: HooksRegistration<E & { __ceb_gateway_subscriptions: Set<Removable> }>
Returns void

decorate

decorate(): PropertyDecorator

Inherited from AbstractGatewayBuilder.decorate
- Defined in packages/ceb-messaging-builder-core/dist/types/builder.d.ts:108
Decorates the property of the gateway.

Returns PropertyDecorator

key

key(key: RegistryKey): GatewayInversionBuilder<E>

- Defined in packages/ceb-messaging-builder-inversion/src/builder.ts:66
Set the registry key.

Parameters
- key: RegistryKey
  
  the registry key
Returns GatewayInversionBuilder<E>

provider

provider(provider: ContainerProvider): GatewayInversionBuilder<E>

- Defined in packages/ceb-messaging-builder-inversion/src/builder.ts:75
Set the Container provider.

Parameters
- provider: ContainerProvider
  
  the provider
Returns GatewayInversionBuilder<E>

subscribe<M>(EventType: string, listener: ElementSubscriptionListener<E, M>, options?: SubscribeOptions): AbstractGatewayBuilder<E>
subscribe<M>(): GatewaySubscriptionBuilder<E, M>

Inherited from AbstractGatewayBuilder.subscribe
- Defined in packages/ceb-messaging-builder-core/dist/types/builder.d.ts:100
Subscribe to a Message Event.

Type parameters
- M: Event<any, MessageHeaders, M>
Parameters
- EventType: string
  
  the type of the event
- listener: ElementSubscriptionListener<E, M>
  
  the listener
- Optional options: SubscribeOptions
  
  the options
Returns AbstractGatewayBuilder<E>
Inherited from AbstractGatewayBuilder.subscribe
- Defined in packages/ceb-messaging-builder-core/dist/types/builder.d.ts:104
When used as a decorator, returns a fresh Subscription builder to decorate a method.

Type parameters
- M: Event<any, MessageHeaders, M>
Returns GatewaySubscriptionBuilder<E, M>

Static get

get<E>(propName?: string): GatewayInversionBuilder<E>

- Defined in packages/ceb-messaging-builder-inversion/src/builder.ts:58
Provides a fresh builder.

Type parameters
- E: HTMLElement
  
  the type of the Custom Element
Parameters
- Optional propName: string
  
  the property name
Returns GatewayInversionBuilder<E>

Static setDefaultContainer

setDefaultContainer(container: Container): void

- Defined in packages/ceb-messaging-builder-inversion/src/builder.ts:49
Set the default Container.

internal
Parameters
- container: Container
  
  the container
Returns void

Type parameters

E: HTMLElement

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Protected constructor

Type parameters

E: HTMLElement

Parameters

_propName: string = "gateway"

_key: RegistryKey = GatewaySymbol

Optional _provider: ContainerProvider

Returns GatewayInversionBuilder<E>

Properties

Protected _gatewayProvider

_propName

Protected _subscriptionsByType

Static Private DEFAULT_CONTAINER

Methods

Protected build

Parameters

Constructor: CustomElementConstructor<E>

hooks: HooksRegistration<E & { __ceb_gateway_subscriptions: Set<Removable> }>

Returns void

decorate

Returns PropertyDecorator

key

Parameters

key: RegistryKey

Returns GatewayInversionBuilder<E>

provider

Parameters

provider: ContainerProvider

Returns GatewayInversionBuilder<E>

subscribe

Type parameters

M: Event<any, MessageHeaders, M>

Parameters

EventType: string

listener: ElementSubscriptionListener<E, M>

Optional options: SubscribeOptions

Returns AbstractGatewayBuilder<E>

Type parameters

M: Event<any, MessageHeaders, M>

Returns GatewaySubscriptionBuilder<E, M>

Static get

Type parameters

E: HTMLElement

Parameters

Optional propName: string

Returns GatewayInversionBuilder<E>

Static setDefaultContainer

Parameters

container: Container

Returns void