Class GatewayClientInternal

constructor

• new GatewayClient(__namedParameters): GatewayClient

• Create a new gateway client.

  Parameters

  • __namedParameters: {
        emitRawEvents?: boolean;
        logEvents?: boolean;
        rest: RESTClient;
    }

    • Optional emitRawEvents?: boolean

    • Optional logEvents?: boolean

    • rest: RESTClient

  Returns GatewayClient

  Example

  import { GatewayClient, RESTClient } from 'eludris.js';
  
    // <snip> - Create your REST client and authenticate.
  
    const gateway = new GatewayClient({
      rest,
      logEvents: true,
    });
  Copy

  Throws

  If emitRawEvents is false and logEvents is true.

emitRawEvents

events

interval

rest

ws

connect

• connect(): Promise<void>

• Connect to the gateway.

  Returns Promise<void>

  Example

  await gateway.connect();
  Copy

  Throws

  If the client is not authenticated.

send

• send(data): Promise<void>

• Send data to the gateway.

  Parameters

  • data: ClientPayload

    The data to send.

  Returns Promise<void>

  Throws

  If the client is not connected.