HomeGuidesAPI Reference
HubBlogChangelogSupport ForumLog In
API Reference

Node.js SDK - RainwaySDK

Home > @rainway/native > RainwaySDK

RainwaySDK class

The Rainway SDK

Signature:

export declare class RainwaySDK extends EventEmitter<RainwaySDKEvents> 

Extends: EventEmitter<RainwaySDKEvents>

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the RainwaySDK class.

Properties

PropertyModifiersTypeDescription
isInitializedbooleanIndicates if the native library has been initialized.
logLevelRainwayLogLevelGet or set the native library log level.
versionstringGet the native library version. A SemVer (https://semver.org/) string.

Methods

MethodModifiersDescription
connect(options)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.