Skip to content

IrohConnectOptions

Defined in: src/client/iroh.ts:206

Options for pipeConnect, the client over raw readable/writable streams.

optional binding?: IrohNativeBinding;

Defined in: src/client/iroh.ts:224

Dependency-injection seam for testing or an application-pinned binding.


optional connectTimeoutMs?: number;

Defined in: src/client/iroh.ts:214

Total endpoint bind, connection, and stream-open deadline. Default: 30000 ms.


optional directAddresses?: readonly string[];

Defined in: src/client/iroh.ts:220

Optional direct socket-address hints for the remote endpoint.


optional externalLocation?: ExternalLocationConfig;

Defined in: src/client/types.ts:76

External storage config for resolving externalized batches.

PipeConnectOptions.externalLocation


optional ioTimeoutMs?: number;

Defined in: src/client/iroh.ts:216

Deadline for each active native read or write. Default: 300000 ms.


optional noRelay?: boolean;

Defined in: src/client/iroh.ts:212

Disable relay use. Direct discovery/addressing must then succeed.


optional onLog?: (msg) => void;

Defined in: src/client/types.ts:74

Callback invoked for each log/error message the server emits during a request.

Parameter Type
msg LogMessage

void

PipeConnectOptions.onLog


optional relayUrls?: readonly string[];

Defined in: src/client/iroh.ts:210

Custom relay URLs. Mutually exclusive with noRelay.


optional remoteRelayUrl?: string;

Defined in: src/client/iroh.ts:218

Optional relay hint for the remote endpoint.


optional secretKey?: Uint8Array<ArrayBufferLike>;

Defined in: src/client/iroh.ts:208

Optional 32-byte Ed25519 secret. Omit for a process-local ephemeral identity.


optional signal?: AbortSignal;

Defined in: src/client/iroh.ts:222

Cancels connection setup and later closes the active native connection.