HomeGuidesAPI Reference
HubBlogChangelogSupport ForumLog In
API Reference

Node.js SDK - RainwaySDK.connect()

Home > @rainway/native > RainwaySDK > connect

RainwaySDK.connect() method

Connects to the Rainway network, creating a RainwayConnection if successful. This is the first step required to connect to other Peers on the Rainway network, or to allow them to connect to you.

Signature:

connect(options: ConnectOptions): Promise<RainwayConnection>;

Parameters

ParameterTypeDescription
optionsConnectOptionsconnection options

Returns:

Promise<RainwayConnection>

A new connection