IrohNativeBinding
Defined in: src/client/iroh.ts:183
Minimal surface implemented by the official @number0/iroh Node binding.
Properties
Section titled “Properties”Endpoint
Section titled “Endpoint”Endpoint: object;Defined in: src/client/iroh.ts:185
Native endpoint factory exported by the binding.
builder()
Section titled “builder()”builder(): NativeEndpointBuilder;Creates a configurable native endpoint builder.
Returns
Section titled “Returns”NativeEndpointBuilder
EndpointAddr
Section titled “EndpointAddr”EndpointAddr: (id, relayUrl?, addresses?) => unknown;Defined in: src/client/iroh.ts:195
Native remote-address constructor exported by the binding.
Combines an endpoint ID with optional relay and direct-address hints.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
unknown |
relayUrl? |
string | null |
addresses? |
string[] | null |
Returns
Section titled “Returns”unknown
EndpointId
Section titled “EndpointId”EndpointId: object;Defined in: src/client/iroh.ts:190
Native endpoint-ID factory exported by the binding.
fromBytes()
Section titled “fromBytes()”fromBytes(bytes): unknown;Decodes a 32-byte endpoint identifier.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
bytes |
number[] |
Returns
Section titled “Returns”unknown
RelayMode
Section titled “RelayMode”RelayMode: object;Defined in: src/client/iroh.ts:200
Native relay-mode factory exported by the binding.
customFromUrls()
Section titled “customFromUrls()”customFromUrls(urls): unknown;Creates a custom relay mode from the supplied relay URLs.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
urls |
string[] |
Returns
Section titled “Returns”unknown