TransferClient
Defined in: src/core/TransferClient.ts:33
Small provider-neutral client that owns provider lookup and connection setup.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new TransferClient(options?: TransferClientOptions): TransferClient;Defined in: src/core/TransferClient.ts:44
Creates a transfer client without opening any provider connections.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
options | TransferClientOptions | Optional registry, provider factories, and logger. |
Returns
Section titled “Returns”TransferClient
Properties
Section titled “Properties”| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
registry | readonly | ProviderRegistry | Provider registry used by this client. | src/core/TransferClient.ts:35 |
Methods
Section titled “Methods”connect()
Section titled “connect()”connect(profile: ConnectionProfile): Promise<TransferSession<unknown>>;Defined in: src/core/TransferClient.ts:93
Opens a provider session using profile.provider, with profile.protocol as compatibility fallback.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
profile | ConnectionProfile | Connection profile containing a provider or legacy protocol field. |
Returns
Section titled “Returns”Promise<TransferSession<unknown>>
A connected provider session.
Throws
Section titled “Throws”ConfigurationError When neither provider nor protocol is present.
getCapabilities()
Section titled “getCapabilities()”Call Signature
Section titled “Call Signature”getCapabilities(): CapabilitySet[];Defined in: src/core/TransferClient.ts:75
Lists all registered provider capability snapshots.
Returns
Section titled “Returns”Call Signature
Section titled “Call Signature”getCapabilities(providerId: ProviderId): CapabilitySet;Defined in: src/core/TransferClient.ts:77
Gets a specific provider capability snapshot.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
providerId | ProviderId |
Returns
Section titled “Returns”hasProvider()
Section titled “hasProvider()”hasProvider(providerId: ProviderId): boolean;Defined in: src/core/TransferClient.ts:70
Checks whether this client can create sessions for a provider id.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
providerId | ProviderId | Provider id to inspect. |
Returns
Section titled “Returns”boolean
true when a provider factory is registered.
registerProvider()
Section titled “registerProvider()”registerProvider(provider: ProviderFactory): this;Defined in: src/core/TransferClient.ts:59
Registers a provider factory with this client’s registry.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
provider | ProviderFactory | Provider factory to register. |
Returns
Section titled “Returns”this
This client for fluent setup.