Class ServicesClient

Client for services.iroh.computer.

Index

Constructors

Methods

name ping pushMetrics setName submitNetworkDiagnostics create

Constructors

constructor

new ServicesClient(): ServicesClient
Returns ServicesClient

Methods

name

name(): Promise<string>
Read the current endpoint name from the local client.

Returns Promise<string>
- Defined in index.d.ts:279

ping

ping(): Promise<void>
Ping the remote service.

Returns Promise<void>
- Defined in index.d.ts:283

pushMetrics

pushMetrics(): Promise<void>
Force a metrics flush.

Returns Promise<void>
- Defined in index.d.ts:285

setName

setName(name: string): Promise<void>
Set the endpoint name cloud-side.
Parameters
- name: string
Returns Promise<void>
- Defined in index.d.ts:281

submitNetworkDiagnostics

submitNetworkDiagnostics(send: boolean): Promise<DiagnosticsSummary>
Run a network-diagnostics report, optionally submitting it.
Parameters
- send: boolean
Returns Promise<DiagnosticsSummary>
- Defined in index.d.ts:287

`Static`create

create(endpoint: Endpoint, options: ServicesOptions): Promise<ServicesClient>
Build a new client bound to the given endpoint.
Parameters
- endpoint: Endpoint
- options: ServicesOptions
Returns Promise<ServicesClient>
- Defined in index.d.ts:277