Class Event<Event>`Abstract`

The builder for a event.

Example

class Ready extends Event {
    name = 'ready';

    execute() {
        console.log('Ready!');
    }
}

Type Parameters

Event extends keyof ClientEvents = keyof ClientEvents

Hierarchy

Event

Index

Constructors

constructor

new Event<Event>(client: Client): Event<Event>
Type Parameters
- Event extends keyof ClientEvents = keyof ClientEvents
Parameters
- client: Client
  
  The client the event belongs to.
Returns Event<Event>
- Defined in framework/src/structures/Event.ts:22

Properties

`Readonly` client

client: Client

The client the event belongs to.

name

name: keyof ClientEvents

The name of the event.

`Optional` once

once?: boolean

Whether the event should run once.

Methods

`Abstract` execute

execute(...args: [client: Client] | [client: Client] | [client: Client] | [client: Client, data: any] | [server: Server, addedBy: ServerMember] | [server: Server, removedBy?: ServerMember] | [message: Message] | [newMessage: Message, oldMessage?: Message] | [message: APIMessageSummary | Message] | [serverMember: ServerMember] | [data: {
    isBan?: boolean;
    isKick?: boolean;
    serverId: string;
    userId: string;
}, server: Server] | [serverBan: ServerBan] | [serverBan: ServerBan] | [newServerMember: ServerMember, oldServerMember?: ServerMember] | [newServerMembers: Collection<string, ServerMember>, oldServerMembers: Collection<string, ServerMember>] | [channel: Channel] | [newChannel: Channel, oldChannel?: Channel] | [channel: Channel] | [webhook: Webhook] | [newWebhook: Webhook, oldWebhook?: Webhook] | [doc: Doc] | [newDoc: Doc, oldDoc?: Doc] | [doc: Doc] | [event: CalendarEvent] | [newCalendarEvent: CalendarEvent, oldCalendarEvent?: CalendarEvent] | [event: CalendarEvent] | [forumTopic: ForumTopic] | [newForumTopic: ForumTopic, oldForumTopic?: ForumTopic] | [forumTopic: ForumTopic] | [forumTopic: ForumTopic] | [forumTopic: ForumTopic] | [forumTopic: ForumTopic] | [forumTopic: ForumTopic] | [newCalendarEventRsvp: CalendarEventRsvp, oldCalendarEventRsvp?: CalendarEventRsvp] | [newCalendarEventRsvps: Collection<string, CalendarEventRsvp>, oldCalendarEventRsvps: Collection<string, CalendarEventRsvp>] | [calendarEventRsvp: CalendarEventRsvp] | [listItem: ListItem] | [newListItem: ListItem, oldListItem?: ListItem] | [listItem: ListItem] | [listItem: ListItem] | [listItem: ListItem] | [reaction: MessageReaction] | [reaction: MessageReaction]): unknown
The execute method of the event.

Example
```
execute() {
    console.log('Ready!');
}
```
Parameters
- Rest ...args: [client: Client] | [client: Client] | [client: Client] | [client: Client, data: any] | [server: Server, addedBy: ServerMember] | [server: Server, removedBy?: ServerMember] | [message: Message] | [newMessage: Message, oldMessage?: Message] | [message: APIMessageSummary | Message] | [serverMember: ServerMember] | [data: {
      isBan?: boolean;
      isKick?: boolean;
      serverId: string;
      userId: string;
  }, server: Server] | [serverBan: ServerBan] | [serverBan: ServerBan] | [newServerMember: ServerMember, oldServerMember?: ServerMember] | [newServerMembers: Collection<string, ServerMember>, oldServerMembers: Collection<string, ServerMember>] | [channel: Channel] | [newChannel: Channel, oldChannel?: Channel] | [channel: Channel] | [webhook: Webhook] | [newWebhook: Webhook, oldWebhook?: Webhook] | [doc: Doc] | [newDoc: Doc, oldDoc?: Doc] | [doc: Doc] | [event: CalendarEvent] | [newCalendarEvent: CalendarEvent, oldCalendarEvent?: CalendarEvent] | [event: CalendarEvent] | [forumTopic: ForumTopic] | [newForumTopic: ForumTopic, oldForumTopic?: ForumTopic] | [forumTopic: ForumTopic] | [forumTopic: ForumTopic] | [forumTopic: ForumTopic] | [forumTopic: ForumTopic] | [forumTopic: ForumTopic] | [newCalendarEventRsvp: CalendarEventRsvp, oldCalendarEventRsvp?: CalendarEventRsvp] | [newCalendarEventRsvps: Collection<string, CalendarEventRsvp>, oldCalendarEventRsvps: Collection<string, CalendarEventRsvp>] | [calendarEventRsvp: CalendarEventRsvp] | [listItem: ListItem] | [newListItem: ListItem, oldListItem?: ListItem] | [listItem: ListItem] | [listItem: ListItem] | [listItem: ListItem] | [reaction: MessageReaction] | [reaction: MessageReaction]
  
  The arguments of the event.
Returns unknown
- Defined in framework/src/structures/Event.ts:32

Class Event<Event>`Abstract`

Example

Type Parameters

Event extends keyof ClientEvents = keyof ClientEvents

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Event extends keyof ClientEvents = keyof ClientEvents

Parameters

client: Client

Returns Event<Event>

Properties

`Readonly` client

name

`Optional` once

Methods

`Abstract` execute

Example

Parameters

Returns unknown

Settings

Member Visibility

Theme

Class Event<Event>Abstract

Example

Type Parameters

Event extends keyof ClientEvents = keyof ClientEvents

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Event extends keyof ClientEvents = keyof ClientEvents

Parameters

client: Client

Returns Event<Event>

Properties

Readonly client

name

Optional once

Methods

Abstract execute

Example

Parameters

Returns unknown

Settings

Member Visibility

Theme

Class Event<Event>`Abstract`

`Readonly` client

`Optional` once

`Abstract` execute