ProviderRegistry

Defined in: src/core/ProviderRegistry.ts:12

Mutable registry of provider factories available to a transfer client.

Constructors

Constructor

new ProviderRegistry(providers?: Iterable<ProviderFactory<TransferProvider<TransferSession<unknown>>>>): ProviderRegistry;

Defined in: src/core/ProviderRegistry.ts:20

Creates a registry and optionally seeds it with provider factories.

Parameters

Parameter	Type	Default value	Description
providers	Iterable<ProviderFactory<TransferProvider<TransferSession<unknown>>>>	[]	Provider factories to register immediately.

Returns

ProviderRegistry

Methods

get()

get(providerId: ProviderId):
  | ProviderFactory<TransferProvider<TransferSession<unknown>>>
  | undefined;

Defined in: src/core/ProviderRegistry.ts:72

Gets a provider factory when registered.

Parameters

Parameter	Type	Description
providerId	ProviderId	Provider id to retrieve.

Returns

| ProviderFactory<TransferProvider<TransferSession<unknown>>> | undefined

The provider factory, or undefined when missing.

---

getCapabilities()

getCapabilities(providerId: ProviderId):
  | CapabilitySet
  | undefined;

Defined in: src/core/ProviderRegistry.ts:103

Gets a provider capability snapshot when registered.

Parameters

Parameter	Type	Description
providerId	ProviderId	Provider id to inspect.

Returns

| CapabilitySet | undefined

Capability snapshot, or undefined when missing.

---

has()

has(providerId: ProviderId): boolean;

Defined in: src/core/ProviderRegistry.ts:62

Checks whether a provider id is registered.

Parameters

Parameter	Type	Description
providerId	ProviderId	Provider id to inspect.

Returns

boolean

true when a provider factory exists.

---

list()

list(): ProviderFactory<TransferProvider<TransferSession<unknown>>>[];

Defined in: src/core/ProviderRegistry.ts:123

Lists registered provider factories in insertion order.

Returns

ProviderFactory<TransferProvider<TransferSession<unknown>>>[]

Registered provider factories.

---

listCapabilities()

listCapabilities(): CapabilitySet[];

Defined in: src/core/ProviderRegistry.ts:132

Lists registered provider capabilities in insertion order.

Returns

CapabilitySet[]

Capability snapshots for every registered provider.

---

register()

register(provider: ProviderFactory): this;

Defined in: src/core/ProviderRegistry.ts:33

Registers a provider factory.

Parameters

Parameter	Type	Description
provider	ProviderFactory	Provider factory to add.

Returns

this

This registry for fluent setup.

Throws

ConfigurationError When a provider id is registered twice.

---

require()

require(providerId: ProviderId): ProviderFactory;

Defined in: src/core/ProviderRegistry.ts:83

Gets a registered provider factory or throws a typed SDK error.

Parameters

Parameter	Type	Description
providerId	ProviderId	Provider id to retrieve.

Returns

ProviderFactory

The registered provider factory.

Throws

UnsupportedFeatureError When no provider has been registered.

---

requireCapabilities()

requireCapabilities(providerId: ProviderId): CapabilitySet;

Defined in: src/core/ProviderRegistry.ts:114

Gets a provider capability snapshot or throws a typed SDK error.

Parameters

Parameter	Type	Description
providerId	ProviderId	Provider id to inspect.

Returns

CapabilitySet

Capability snapshot for the registered provider.

Throws

UnsupportedFeatureError When no provider has been registered.

---

unregister()

unregister(providerId: ProviderId): boolean;

Defined in: src/core/ProviderRegistry.ts:52

Removes a provider factory from the registry.

Parameters

Parameter	Type	Description
providerId	ProviderId	Provider id to remove.

Returns

boolean

true when a provider was removed.