Class Routes

Route is the interface for working with Routes over the AppDaemon query RPC.

Generated

From ts-rpcdb.ts.tmpl

Hierarchy

Routes

Index

Constructors

Properties

Methods

delete get list listByCidr listByNodeID put query

Constructors

constructor

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

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 Route with the given ID.
Parameters
- id: string
  The name of the route.
Returns Promise<void>
- Defined in utils/rpcdb.ts:960

get

get(id): Promise<Route>
Returns the Route with the given ID.
Parameters
- id: string
  The name of the route.
Returns Promise<Route>
The Route with the given ID.
- Defined in utils/rpcdb.ts:937

list

list(): Promise<Route[]>
Returns all Routes.

Returns Promise<Route[]>
All Routes known to the AppDaemon.
- Defined in utils/rpcdb.ts:983

listByCidr

listByCidr(cidr): Promise<Route[]>
Returns the Routes with the given cidr.
Parameters
- cidr: string
  The CIDR of the route
Returns Promise<Route[]>
Any Routes found with the given cidr.
- Defined in utils/rpcdb.ts:1006

listByNodeID

listByNodeID(nodeid): Promise<Route[]>
Returns the Routes with the given nodeid.
Parameters
- nodeid: string
  The ID of the node
Returns Promise<Route[]>
Any Routes found with the given nodeid.
- Defined in utils/rpcdb.ts:1030

put

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

`Private` query

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

Generated using TypeDoc