Class BaseDiscordEvent<T>

Generic Data Transfer Object, used widely in Takaro to pass data back and forth between components Allows validation of properties when instantiated and JSON (de)serialization

Type Parameters

T

Hierarchy (View Summary)

BaseEvent<T>
- BaseDiscordEvent

Index

Constructors

Properties

msg timestamp type

Methods

toJSON validate

Constructors

constructor

new BaseDiscordEvent<T>(data?: Nullable<DeepPartial<T>>): BaseDiscordEvent<T>
Type Parameters
- T
Parameters
- Optionaldata: Nullable<DeepPartial<T>>
Returns BaseDiscordEvent<T>
Inherited from BaseEvent.constructor
- Defined in lib-util/dist/TakaroDTO.d.ts:14

Properties

msg

msg: string

timestamp

timestamp: string = ...

type

type: "discord-message"

Methods

toJSON

toJSON(optionOverrides?: ClassTransformOptions): Record<string, any>
Parameters
- OptionaloptionOverrides: ClassTransformOptions
Returns Record<string, any>
Inherited from BaseEvent.toJSON
- Defined in lib-util/dist/TakaroDTO.d.ts:21

validate

validate(extraOpts?: ValidatorOptions): Promise<void>
Validates the DTO instance
Parameters
- OptionalextraOpts: ValidatorOptions
Returns Promise<void>
Throws
if validation fails
Inherited from BaseEvent.validate
- Defined in lib-util/dist/TakaroDTO.d.ts:20