Class EventDiscordUser

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

Hierarchy (View Summary)

TakaroDTO<EventDiscordUser>
- EventDiscordUser

Index

Constructors

Properties

displayName id isBot isTakaroBot username

Methods

toJSON validate

Constructors

constructor

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

Properties

displayName

displayName: string

id

id: string

isBot

isBot: boolean

isTakaroBot

isTakaroBot: boolean

username

username: string

Methods

toJSON

toJSON(optionOverrides?: ClassTransformOptions): Record<string, any>
Parameters
- OptionaloptionOverrides: ClassTransformOptions
Returns Record<string, any>
Inherited from TakaroDTO.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 TakaroDTO.validate
- Defined in lib-util/dist/TakaroDTO.d.ts:20