JS API Reference
Class: NetworkNode
network/node.NetworkNode
Describes a node in a VPN, mapping a Golem node id to an IP address
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new NetworkNode(id
, ip
, getNetworkInfo
, yagnaBaseUri
): NetworkNode
Parameters
Name | Type |
---|---|
id | string |
ip | string |
getNetworkInfo | () => NetworkInfo |
yagnaBaseUri | string |
Returns
Defined in
Properties
id
• Readonly
id: string
Defined in
ip
• Readonly
ip: string
Defined in
getNetworkInfo
• getNetworkInfo: () => NetworkInfo
Type declaration
▸ (): NetworkInfo
Returns
Defined in
yagnaBaseUri
• yagnaBaseUri: string
Defined in
Methods
getNetworkConfig
▸ getNetworkConfig(): Object
Generate a dictionary of arguments that are required for the appropriate Deploy
command of an exescript in order to pass the network configuration to the runtime on the provider's end.
Returns
Object
Name | Type |
---|---|
net | { nodeIp : string ; id : string ; ip : string ; mask : string ; gateway? : string ; nodes : { [ip: string] : string ; } }[] |
Defined in
getWebsocketUri
▸ getWebsocketUri(port
): string
Parameters
Name | Type |
---|---|
port | number |
Returns
string
Defined in
Was this helpful?