IrohConnectOptions
Defined in: src/client/iroh.ts:206
Options for pipeConnect, the client over raw readable/writable streams.
Extends
Section titled “Extends”Properties
Section titled “Properties”binding?
Section titled “binding?”optional binding?: IrohNativeBinding;Defined in: src/client/iroh.ts:224
Dependency-injection seam for testing or an application-pinned binding.
connectTimeoutMs?
Section titled “connectTimeoutMs?”optional connectTimeoutMs?: number;Defined in: src/client/iroh.ts:214
Total endpoint bind, connection, and stream-open deadline. Default: 30000 ms.
directAddresses?
Section titled “directAddresses?”optional directAddresses?: readonly string[];Defined in: src/client/iroh.ts:220
Optional direct socket-address hints for the remote endpoint.
externalLocation?
Section titled “externalLocation?”optional externalLocation?: ExternalLocationConfig;Defined in: src/client/types.ts:76
External storage config for resolving externalized batches.
Inherited from
Section titled “Inherited from”PipeConnectOptions.externalLocation
ioTimeoutMs?
Section titled “ioTimeoutMs?”optional ioTimeoutMs?: number;Defined in: src/client/iroh.ts:216
Deadline for each active native read or write. Default: 300000 ms.
noRelay?
Section titled “noRelay?”optional noRelay?: boolean;Defined in: src/client/iroh.ts:212
Disable relay use. Direct discovery/addressing must then succeed.
onLog?
Section titled “onLog?”optional onLog?: (msg) => void;Defined in: src/client/types.ts:74
Callback invoked for each log/error message the server emits during a request.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
msg |
LogMessage |
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”relayUrls?
Section titled “relayUrls?”optional relayUrls?: readonly string[];Defined in: src/client/iroh.ts:210
Custom relay URLs. Mutually exclusive with noRelay.
remoteRelayUrl?
Section titled “remoteRelayUrl?”optional remoteRelayUrl?: string;Defined in: src/client/iroh.ts:218
Optional relay hint for the remote endpoint.
secretKey?
Section titled “secretKey?”optional secretKey?: Uint8Array<ArrayBufferLike>;Defined in: src/client/iroh.ts:208
Optional 32-byte Ed25519 secret. Omit for a process-local ephemeral identity.
signal?
Section titled “signal?”optional signal?: AbortSignal;Defined in: src/client/iroh.ts:222
Cancels connection setup and later closes the active native connection.
