Class FeatureServiceRegistry

The FeatureServiceRegistry provides Feature Services to dependent consumers. The integrator should instantiate a singleton instance of the registry.

Hierarchy

FeatureServiceRegistry

Index

Constructors

Methods

bindFeatureServices getInfo registerFeatureServices

Constructors

constructor

new FeatureServiceRegistry(options?: FeatureServiceRegistryOptions): FeatureServiceRegistry
Parameters
- options: FeatureServiceRegistryOptions = {}
Returns FeatureServiceRegistry
- Defined in packages/core/src/feature-service-registry.ts:191

Methods

bindFeatureServices

bindFeatureServices(consumerDefinition: FeatureServiceConsumerDefinition, consumerId: string, consumerName?: string): FeatureServicesBinding<FeatureServices>
Bind all dependencies to a consumer.

Throws
Throws an error if non-optional dependencies can't be fulfilled.

Throws
Throws an error if called with the same consumer ID more than once.
Parameters
- consumerDefinition: FeatureServiceConsumerDefinition
  
  The definition of the consumer to which dependencies should be bound.
- consumerId: string
  
  The ID of the consumer to which dependencies should be bound.
- Optional consumerName: string
  
  The name of the consumer to which dependencies should be bound.
Returns FeatureServicesBinding<FeatureServices>
- Defined in packages/core/src/feature-service-registry.ts:246

getInfo

getInfo(): FeatureServiceRegistryInfo
Returns info about consumers and registered feature services.

Returns FeatureServiceRegistryInfo
- Defined in packages/core/src/feature-service-registry.ts:325

registerFeatureServices

registerFeatureServices(providerDefinitions: FeatureServiceProviderDefinition<SharedFeatureService, FeatureServices>[], registrantId: string): void
Register a set of Feature Services to make them available for binding to dependent consumers.

Throws
Throws an error if the dependencies of one of the provider definitions can't be fulfilled.

Throws
Throws an error if one of the registered Feature Services contains an invalid version according to semver notation.
Parameters
- providerDefinitions: FeatureServiceProviderDefinition<SharedFeatureService, FeatureServices>[]
  
  Feature Services that should be registered. A Feature Service and its dependencies must either be registered together, or the dependencies must have already been registered. It is not possible to provide dependencies later. Sorting the provided definitions is not necessary, since the registry takes care of registering the given definitions in the correct order.
- registrantId: string
  
  The ID of the entity that registers the provider definitions.
Returns void
- Defined in packages/core/src/feature-service-registry.ts:215

Generated using TypeDoc