Class MeshNodes

MeshNode is the interface for working with MeshNodes over the AppDaemon query RPC.

Generated

From ts-rpcdb.ts.tmpl

Hierarchy

MeshNodes

Index

Constructors

Properties

Methods

delete get getByPubkey list put query

Constructors

constructor

new MeshNodes(client, connID): MeshNodes
Parameters
- client: AppDaemonQuerier
  The client to use for RPC calls.
- connID: string
  The connection ID to use for RPC calls.
Returns MeshNodes
- Defined in utils/rpcdb.ts:63

Properties

`Private` `Readonly` client

client: AppDaemonQuerier

The client to use for RPC calls.

`Private` `Readonly` connID

connID: string

The connection ID to use for RPC calls.

Methods

delete

delete(id): Promise<void>
Deletes the MeshNode with the given ID.
Parameters
- id: string
  The ID of the node.
Returns Promise<void>
- Defined in utils/rpcdb.ts:148

get

get(id): Promise<MeshNode>
Returns the MeshNode with the given ID.
Parameters
- id: string
  The ID of the node.
Returns Promise<MeshNode>
The MeshNode with the given ID.
- Defined in utils/rpcdb.ts:97

getByPubkey

getByPubkey(pubkey): Promise<MeshNode>
Returns the MeshNode with the given pubkey.
Parameters
- pubkey: string
  The base64 encoded public key of the node.
Returns Promise<MeshNode>
The MeshNode with the given pubkey.
- Defined in utils/rpcdb.ts:121

list

list(): Promise<MeshNode[]>
Returns all MeshNodes.

Returns Promise<MeshNode[]>
All MeshNodes known to the AppDaemon.
- Defined in utils/rpcdb.ts:171

put

put(obj): Promise<void>
Puts the given MeshNode.
Parameters
- obj: MeshNode
  The MeshNode to put into the mesh storage.
Returns Promise<void>
- Defined in utils/rpcdb.ts:193

`Private` query

query(query): Promise<QueryResponse>
Queries the AppDaemon for MeshNodes.
Parameters
- query: QueryRequest
  The query to run.
Returns Promise<QueryResponse>
The results of the query.
- Defined in utils/rpcdb.ts:74

Generated using TypeDoc