Class Utils

Utils is an API module for various Textile node utilities

extends: API

Hierarchy

API
- Utils

Index

Constructors

constructor

Methods

Constructors

constructor

new Utils(opts?: ApiOptions): Utils

Inherited from API.__constructor
- Defined in core/api.ts:68
Parameters
- Default value opts: ApiOptions = DEFAULT_API_OPTIONS
Returns Utils

Methods

online

online(): Promise<boolean>

- Defined in modules/utils.ts:42
Check whether the underlying node's API is online

Returns Promise<boolean>

Whether the API is online

ping

ping(id: string): Promise<string>

- Defined in modules/utils.ts:33
Pings another peer on the network, returning wherther they are online or offline.

Parameters
- id: string
  
  The peer id
Returns Promise<string>

Whether the peer is online

summary

summary(): Promise<Summary>

- Defined in modules/utils.ts:23
Get a summary of all local node data

Returns Promise<Summary>

Summary of node activity

version

version(): Promise<Versions>

- Defined in modules/utils.ts:14
Get the current node's API, and application versions

Returns Promise<Versions>

Version of Cafe API and node binary release