Class BaseStruct

Basic structure that all other API-related structures extend Includes the bot property which every structure must have

Hierarchy

BaseStruct

Index

Constructors

constructor

Properties

bot

Methods

Constructors

constructor

new BaseStruct(bot: Bot, structure: GatewayStruct): BaseStruct

- Defined in src/structures/base/BaseStruct.ts:34
Parameters
- bot: Bot
- structure: GatewayStruct
Returns BaseStruct

Properties

bot

bot: Bot

The Bot operating this structure

Methods

clone

clone(): this

- Defined in src/structures/base/BaseStruct.ts:55
Clone a structure

Returns this

init

init(_struct: GatewayStruct): this

- Defined in src/structures/base/BaseStruct.ts:47
Virtual init method

Parameters
- _struct: GatewayStruct
  
  The structure to initialize from
Returns this

update

update(data: GatewayStruct): UpdateReturn<this>

- Defined in src/structures/base/BaseStruct.ts:64
Update a structure and return its before and after versions

Parameters
- data: GatewayStruct
  
  The updated data
Returns UpdateReturn<this>

Generated using TypeDoc