Birb / Birb

Class: Birb

Hierarchy

• EventDispatcher<BirbEvent>

  ↳ Birb

Table of contents

Constructors

• constructor

Properties

• baseApiUrl
• guilds
• intents
• options
• ping
• users
• ws

Methods

• clear
• fly
• getToken
• setToken
• when

Constructors

constructor

• new Birb(options)

Your journey starts here! :D

Parameters

Overrides

EventDispatcher.constructor

Defined in

src/classes/Birb.ts:51

Properties

baseApiUrl

• Readonly baseApiUrl: string = 'https://discord.com/api/v10'

The base URL for API requests.

Defined in

src/classes/Birb.ts:22

---

guilds

• guilds: GuildsManager

The guilds manager.

Defined in

src/classes/Birb.ts:40

---

intents

• Readonly intents: Intents

The Intents Bitfield the client was initialized with.

Defined in

src/classes/Birb.ts:18

---

options

• Readonly options: BirbOptions

The options passed to the Birb constructor.

Defined in

src/classes/Birb.ts:14

---

ping

• ping: number = 0

The current websocket latency to Discord, in milliseconds.

Defined in

src/classes/Birb.ts:36

---

users

• users: UsersManager

The users manager.

Defined in

src/classes/Birb.ts:44

---

ws

• ws: Websocket

The websocket for the client.

Defined in

src/classes/Birb.ts:26

Methods

clear

▸ clear(): void

Returns

void

Inherited from

EventDispatcher.clear

Defined in

src/classes/EventDispatcher.ts:35

---

fly

▸ fly(): Promise<Birb>

Returns

Promise<Birb>

Defined in

src/classes/Birb.ts:72

---

getToken

▸ getToken(): undefined | string

Seriously though, don’t share your bot’s token with anyone!

Returns

undefined | string

Defined in

src/classes/Birb.ts:100

---

setToken

▸ setToken(token): Birb

Sets the token.

Parameters

Returns

Birb

Defined in

src/classes/Birb.ts:92

---

when

▸ when(event): EventListener<BirbEvent, Function>

Parameters

Returns

EventListener<BirbEvent, Function>

Inherited from

EventDispatcher.when

Defined in

src/classes/EventDispatcher.ts:14

---