Class BaseObject<APIType>

Type Parameters

APIType extends {
    _id: string | {
        user: string;
    };
}

Hierarchy

MiniEmitter
- BaseObject
  - Attachment
  - AuthSession
  - BaseMessage
  - Category
  - Channel
  - Emoji
  - GlobalInvite
  - Member
  - Role
  - Server
  - ServerInvite
  - User

Index

Constructors

Properties

client data deleted

Accessors

_id createdAt id source

Methods

fireUpdate offUpdate onUpdate toString update

Constructors

constructor

new BaseObject<APIType>(client: Client, data: APIType): BaseObject<APIType>
Type Parameters
- APIType extends {
      _id: string | {
          user: string;
      };
  }
Parameters
- client: Client
- data: APIType
Returns BaseObject<APIType>
Overrides MiniEmitter.constructor
- Defined in core/src/objects/BaseObject.ts:13

Properties

client

client: Client

`Private` data

data: APIType

deleted

deleted: boolean = false

Accessors

`Protected` _id

get _id(): ""
Returns ""
- Defined in core/src/objects/BaseObject.ts:10

createdAt

get createdAt(): number
Returns number
- Defined in core/src/objects/BaseObject.ts:19

id

get id(): string
Returns string
- Defined in core/src/objects/BaseObject.ts:16

source

get source(): APIType
Original API object.

Returns APIType
- Defined in core/src/objects/BaseObject.ts:7

Methods

fireUpdate

fireUpdate(updated?: any[]): void
Runs all of the callbacks for this emitter. (meant to run when an update occurs)
Parameters
- Optional updated: any[]
  
  The objects that caused this update.
Returns void
Inherited from MiniEmitter.fireUpdate
- Defined in core/src/utils/MiniEmitter.ts:33

offUpdate

offUpdate(callback: MiniEmitterCallback<any>): BaseObject<APIType>
Stops listening for Map updates.

Returns
this, useful for chaining.
Parameters
- callback: MiniEmitterCallback<any>
  
  The callback to stop listening for updates on.
Returns BaseObject<APIType>
Inherited from MiniEmitter.offUpdate
- Defined in core/src/utils/MiniEmitter.ts:24

onUpdate

onUpdate(callback: MiniEmitterCallback<any>): BaseObject<APIType>
Listen for an update to this Map.

Returns
this, useful for chaining.
Parameters
- callback: MiniEmitterCallback<any>
  
  The callback to run when an update occurs.
Returns BaseObject<APIType>
Inherited from MiniEmitter.onUpdate
- Defined in core/src/utils/MiniEmitter.ts:15

toString

toString(): string
Converts this object to a string.

Returns
The object ID.

Returns string
- Defined in core/src/objects/BaseObject.ts:33

update

update(data?: Partial<APIType>): BaseObject<APIType>
Update this object with new API data.
Parameters
- data: Partial<APIType> = {}
Returns BaseObject<APIType>
- Defined in core/src/objects/BaseObject.ts:24