Class Client

The main hub for interacting with the Guilded API.

Example

// Start the client
new Client();
// Start the client in development mode
new Client({ dev: true });

Hierarchy

Constructors

constructor

Properties

channels commands config groups options prefixes rest servers token? user? users ws

Accessors

api isReady readyAt readyTimestamp uptime

Methods

debug disconnect init login

Constructors

constructor

Properties

Readonly channels

channels: ChannelManager

The manager of channels that belong to the client.

Readonly commands

commands: Collection<string, Command> = ...

The commands that belong to the client.

config

config: ClientConfig

The config for the client.

Readonly groups

groups: GroupManager

The manager of groups that belong to the client.

Readonly options

options: ClientOptions = {}

The options for the client.

Readonly prefixes

prefixes: Collection<string, string> = ...

The prefixes per server.

Readonly rest

rest: RESTManager

The REST manager for the Guilded API.

Readonly servers

servers: ServerManager

The manager of servers that belong to the client.

Optional token

token?: string

The auth token for the Guilded API.

Optional user

user?: ClientUser

The user the client is logged in as.

Readonly users

users: UserManager

The manager of users that belong to the client.

Readonly ws

ws: WebsocketManager

The Websocket manager for the Guilded API.

Accessors

api

  • get api(): Router

  • The router for the Guilded REST API.

    Returns Router

isReady

  • get isReady(): boolean

  • Whether the client is ready to use.

    Returns boolean

readyAt

  • get readyAt(): undefined | Date

  • The date the client was ready.

    Returns undefined | Date

readyTimestamp

  • get readyTimestamp(): undefined | number

  • The timestamp the client was ready.

    Returns undefined | number

uptime

  • get uptime(): undefined | number

  • The time the client has been in the ready state.

    Returns undefined | number

Methods

debug

  • Debug the client.

    Returns

    The client.

    Example

    client.debug('Hello World!');

    Parameters

    • Optional data: any

      The debug data.

    Returns Client

disconnect

  • Disconnect from Guilded.

    Returns

    The client.

    Example

    client.disconnect();

    Returns Client

init

login

  • Login to the Guilded API.

    Returns

    The client.

    Example

    client.login('token');

    Parameters

    • Optional token: string

      The auth token for the Guilded API.

    Returns Promise<Client>

Settings

Member Visibility

Theme