Class Client

The main hub for interacting with the Guilded API.

Example

const client = new Client(); client.once('ready', () => console.log(Logged in as ${client.user!.name}!)); client.login('token');

Hierarchy

EventEmitter
- Client

Index

Constructors

constructor

new Client(options?: ClientOptions): Client
Parameters
- options: ClientOptions = {}
  
  The options for the client.
Returns Client
Overrides EventEmitter.constructor
- Defined in guilded.ts/src/structures/Client.ts:53

Properties

`Readonly` channels

channels: ChannelManager

The manager of channels that belong to the client.

`Readonly` groups

groups: GroupManager

The manager of groups that belong to the client.

options

options: ClientOptions = {}

The options for the client.

`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
- Defined in guilded.ts/src/structures/Client.ts:79

isReady

get isReady(): boolean
Whether the client is ready to use.

Returns boolean
- Defined in guilded.ts/src/structures/Client.ts:84

readyAt

get readyAt(): undefined | Date
The date the client was ready.

Returns undefined | Date
- Defined in guilded.ts/src/structures/Client.ts:89

readyTimestamp

get readyTimestamp(): undefined | number
The timestamp the client was ready.

Returns undefined | number
- Defined in guilded.ts/src/structures/Client.ts:94

uptime

get uptime(): undefined | number
The time the client has been in the ready state.

Returns undefined | number
- Defined in guilded.ts/src/structures/Client.ts:99

Methods

debug

debug(data?: any): Client
Debug the client.

Returns
The client.

Example
```
client.debug('Hello World!');
```
Parameters
- Optional data: any
  
  The debug data.
Returns Client
- Defined in guilded.ts/src/structures/Client.ts:132

disconnect

disconnect(): Client
Disconnect from Guilded.

Returns
The client.

Example
```
client.disconnect();
```
Returns Client
- Defined in guilded.ts/src/structures/Client.ts:121

login

login(token?: string): Promise<Client>
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>
- Defined in guilded.ts/src/structures/Client.ts:109

Class Client

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: ClientOptions = {}

Returns Client

Properties

Readonly channels

Readonly groups

options

Readonly rest

Readonly servers

Optional token

Optional user

Readonly users

Readonly ws

Accessors

api

Returns Router

isReady

Returns boolean

readyAt

Returns undefined | Date

readyTimestamp

Returns undefined | number

uptime

Returns undefined | number

Methods

debug

Returns

Example

Parameters

Optional data: any

Returns Client

disconnect

Returns

Example

Returns Client

login

Returns

Example

Parameters

Optional token: string

Returns Promise<Client>

Settings

Member Visibility

Theme

`Readonly` channels

`Readonly` groups

`Readonly` rest

`Readonly` servers

`Optional` token

`Optional` user

`Readonly` users

`Readonly` ws

`Optional` data: any

`Optional` token: string