Connection API Reference

API documentation for connection module

Connection

class Connection extends EventEmitter

Properties

  on: (event: K, listener: (undefined: unknown) => void) => this;
  _auth: object;
  _baseURL: string;
  _socketURL: string;
  _socket?: WebSocket;
  _refresher: ReturnType<typeof setTimeout> | null;
  deviceID: UniqueId;
  access_token: string;
  _retryOptions: object;
  get isOpen(): boolean;

Methods

static connect(
  baseURL: string,
  client_id: string,
  client_secret: string,
  deviceID: string,
  tokenURL?: string,
  retryOptions?: typeof Connection.prototype._retryOptions
): Connection
_createWebSocketAndAttachEventHandlers(): void
send(data: ApplicationData): void
json(obj: unknown): void
async sendAndGetResponse(
  applicationData: ApplicationData
): Promise<PlatformData>
close(code?: number, reason?: string): void
[Symbol.dispose](): void