Class AbstractLibrary`Abstract`

The abstract class for developing library

Index

Constructors

Methods

getId getShardCount sendPacket listen

Constructors

constructor

new AbstractLibrary(client): AbstractLibrary
Parameters
- client: any
Returns AbstractLibrary
- Defined in src/Library/AbstractLibrary.ts:14

Methods

`Abstract`getId

getId(): string
A getter where the lib stores the client user (the one logged in as a bot) id

Returns string
string
- Defined in src/Library/AbstractLibrary.ts:39

`Abstract`getShardCount

getShardCount(): number
For dealing ws with lavalink server

Returns number
number
- Defined in src/Library/AbstractLibrary.ts:45

`Abstract`sendPacket

sendPacket(shardId, payload, important): void
Where your library send packets to Discord Gateway
Parameters
- shardId: number
  The current shard Id
- payload: any
  The payload data to request with discord gateway
- important: boolean
  If this payload important or not
Returns void
- Defined in src/Library/AbstractLibrary.ts:53

`Abstract`listen

listen(nodes): void
Listen attaches the event listener to the library you are using
Parameters
- nodes: RainlinkNodeOptions[]
  All current nodes in the array
Returns void
- Defined in src/Library/AbstractLibrary.ts:59