Client | fuwa.js

The base Client to access and configure your discord bot. The client should be imported from fuwa.js and extended either as a variable or class.

example

import { Client } from "fuwa.js"
const bot = new Client({})
// or
class bot extends Client {}

Both will work in javascript or typescript.

Hierarchy

WebSocket
- Client

Constructors

constructor

new Client(options?: ClientOptions): Client

Overrides WebSocket.constructor
- Defined in lib/structures/handlers/Client.ts:140
Parameters
- Optional options: ClientOptions
Returns Client

Properties

_interactionListeners

_interactionListeners: Map<string, CommandCallback> = ...

Interaction listeners for buttons

applicationId

applicationId: string

Your bot ID

bot

bot: BotUser = null

cache

cache: Cache

commands

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

A Map of commands

Protected connected

connected: boolean = false

Protected debug

debug: Debug

events

events: Map<keyof EventHandlersDefinitions, (...args: any[]) => any> = ...

A Map of fuwa#client events

Protected intents

DiscordAPI GateWay Intents

Protected Optional loop

loop?: Timeout

mountingCommands

mountingCommands: Command[] = ...

Commands that will be mounted before the ready event

once

once: <T>(event: T, callback: EventHandlers[T]) => Client = ...

Type declaration

- <T>(event: T, callback: EventHandlers[T]): Client
- Alias for on
  
  Type parameters
  - T: keyof EventHandlersDefinitions
    
    The event name
  Parameters
  - event: T
  - callback: EventHandlers[T]
  Returns Client

Protected options

options: ClientOptions

Options to pass to the client

plugins

plugins: Plugin[]

Protected response

response: { events: { emit: <T>(t: T, d: GatewayEvents[T]) => void }; op: { emit: <T>(op: T, d: GatewayCommands[T]["d"]) => void } } = ...

Type declaration

events: { emit: <T>(t: T, d: GatewayEvents[T]) => void }
- emit: <T>(t: T, d: GatewayEvents[T]) => void
  - - <T>(t: T, d: GatewayEvents[T]): void
    - Type parameters
      - T: keyof GatewayEvents
      Parameters
      - t: T
      - d: GatewayEvents[T]
      Returns void
op: { emit: <T>(op: T, d: GatewayCommands[T]["d"]) => void }
- emit: <T>(op: T, d: GatewayCommands[T]["d"]) => void
  - - <T>(op: T, d: GatewayCommands[T]["d"]): void
    - Type parameters
      - T: number
      Parameters
      - op: T
      - d: GatewayCommands[T]["d"]
      Returns void

Protected session

session: { id: string; seq: number } = ...

Type declaration

id: string
seq: number

shardCount

shardCount: number

Protected token

token: string = ''

ws

ws: any

Methods

command

command(name: string, data: CommandCallback | { args?: Argument[]; desc?: string; guild?: string }, cb?: CommandCallback): Client

- Defined in lib/structures/handlers/Client.ts:425
Parameters
- name: string
- data: CommandCallback | { args?: Argument[]; desc?: string; guild?: string }
- Optional cb: CommandCallback
Returns Client

Protected connect

connect(url: string, version: 6 | 8 | 9): void

Inherited from WebSocket.connect
- Defined in lib/structures/internet/WebSocket.ts:39
ws connection

Parameters
- url: string
  
  websocket url to connect to
- version: 6 | 8 | 9
  
  api version to connect to
Returns void

Protected event

event<T>(e: T, cb: (data: GatewayEvents[T]["d"]) => void): void

Inherited from WebSocket.event
- Defined in lib/structures/internet/WebSocket.ts:72
Type parameters
- T: keyof GatewayEvents
Parameters
- e: T
- cb: (data: GatewayEvents[T]["d"]) => void
  - - (data: GatewayEvents[T]["d"]): void
    - Parameters
      - data: GatewayEvents[T]["d"]
      Returns void
Returns void

getChannel

getChannel(cid: string, force?: boolean): Promise<Channel>

- Defined in lib/structures/handlers/Client.ts:253
Parameters
- cid: string
- force: boolean = false
Returns Promise<Channel>

getGuild

getGuild(gid: string, withSize?: boolean, force?: boolean): Promise<Guild>

- Defined in lib/structures/handlers/Client.ts:239
Allows easy access to the fuwa.js#Guild information.

Parameters
- gid: string
  
  Id of the guild you want to fetch
- withSize: boolean = false
  
  If you want the guild to contain the approximant member count of the guild (and presences), warning this may slow down the request so only use if needed
- force: boolean = false
Returns Promise<Guild>
A Guild, or null if the guild was not found

getMountedCommands

getMountedCommands(guildId?: string): Promise<ApplicationCommand[]>

- Defined in lib/structures/handlers/Client.ts:262
Returns all mounted commands and there discord data.

Parameters
- Optional guildId: string
  
  the id of the guild your application command is registered in.
Returns Promise<ApplicationCommand[]>

getUser

getUser<T>(uid: T): Promise<T extends "@me" ? BotUser : User>

- Defined in lib/structures/handlers/Client.ts:245
Type parameters
- T: string
Parameters
- uid: T
Returns Promise<T extends "@me" ? BotUser : User>

login

- Defined in lib/structures/handlers/Client.ts:298
Connects the websocket client to discords api.

see
https://discord.com/developers/applications

Parameters
- Optional token: string | Buffer
  
  Your discord bot token.
Returns void

logout

logout<T>(end: T): T extends true ? void : never

- Defined in lib/structures/handlers/Client.ts:403
Shuts down the bot process.

Type parameters
- T: boolean
Parameters
- end: T
Returns T extends true ? void : never

mountCommand

mountCommand(cmd: Command): Promise<Client>

- Defined in lib/structures/handlers/Client.ts:195
Mounts a command at runtime

Parameters
- cmd: Command
  
  The slash command to mount to the client.
Returns Promise<Client>

on

on<T>(event: T, callback: EventHandlers[T]): Client

- Defined in lib/structures/handlers/Client.ts:183
Type parameters
- T: keyof EventHandlersDefinitions
  
  The event name
Parameters
- event: T
- callback: EventHandlers[T]
Returns Client

Protected op

op<T>(op: T, cb: (data: GatewayCommands[T]["d"]) => void): void

Inherited from WebSocket.op
- Defined in lib/structures/internet/WebSocket.ts:69
Type parameters
- T: number
Parameters
- op: T
- cb: (data: GatewayCommands[T]["d"]) => void
  - - (data: GatewayCommands[T]["d"]): void
    - Parameters
      - data: GatewayCommands[T]["d"]
      Returns void
Returns void

Protected parseDiscordEventNames

parseDiscordEventNames(e: string): string

- Defined in lib/structures/handlers/Client.ts:271
Parameters
- e: string
Returns string

Protected spawnShard

spawnShard(shardId: number, data: Identify): Promise<void>

- Defined in lib/structures/handlers/Client.ts:417
Parameters
- shardId: number
  
  the shard(s) spawned from websocket
- data: Identify
  
  discord raw api json
Returns Promise<void>

unmountCommand

unmountCommand(cmd: string | Command, guildId?: string): Promise<{ _metadata: any; blob: Blob; buffer: Buffer; data: any; headers: Map<string, string>; status: HTTPResponseCodes }>

- Defined in lib/structures/handlers/Client.ts:217
Deletes a command from the discord api.

Parameters
- cmd: string | Command
  
  command id
- Optional guildId: string
  
  only needed if your command is a guild command and your id is a string
Returns Promise<{ _metadata: any; blob: Blob; buffer: Buffer; data: any; headers: Map<string, string>; status: HTTPResponseCodes }>

Protected wsEvent

wsEvent<T>(e: T, cb: (data: any) => any): void

Inherited from WebSocket.wsEvent
- Defined in lib/structures/internet/WebSocket.ts:75
Type parameters
- T: "message" | "open"
Parameters
- e: T
- cb: (data: any) => any
  - - (data: any): any
    - Parameters
      - data: any
      Returns any
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: ClientOptions

Returns Client

Properties

_interactionListeners

applicationId

bot

cache

commands

Protected connected

Protected debug

events

Protected intents

Protected Optional loop

mountingCommands

once

Type declaration

Type parameters

T: keyof EventHandlersDefinitions

Parameters

event: T

callback: EventHandlers[T]

Returns Client

Protected options

plugins

Protected response

Type declaration

events: { emit: <T>(t: T, d: GatewayEvents[T]) => void }

emit: <T>(t: T, d: GatewayEvents[T]) => void

Type parameters

T: keyof GatewayEvents

Parameters

t: T

d: GatewayEvents[T]

Returns void

op: { emit: <T>(op: T, d: GatewayCommands[T]["d"]) => void }

emit: <T>(op: T, d: GatewayCommands[T]["d"]) => void

Type parameters

T: number

Parameters

op: T

d: GatewayCommands[T]["d"]

Returns void

Protected session

Type declaration

id: string

seq: number

shardCount

Protected token

ws

Methods

command

Parameters

name: string

data: CommandCallback | { args?: Argument[]; desc?: string; guild?: string }

Optional cb: CommandCallback

Returns Client

Protected connect

Parameters

url: string

version: 6 | 8 | 9

Returns void

Protected event

Type parameters

T: keyof GatewayEvents

Parameters

e: T

cb: (data: GatewayEvents[T]["d"]) => void

Parameters

data: GatewayEvents[T]["d"]

Returns void

Returns void

getChannel