Class TakaroEventPlayerNewNameDetected

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)

BaseEvent<TakaroEventPlayerNewNameDetected>
- TakaroEventPlayerNewNameDetected

Index

Constructors

constructor

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

Properties

newName

newName: string

oldName

oldName: string | null

timestamp

timestamp: string = ...

type

type: "player-new-name-detected" = TakaroEvents.PLAYER_NEW_NAME_DETECTED

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

Class TakaroEventPlayerNewNameDetected

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TakaroEventPlayerNewNameDetected

Properties

newName

oldName

timestamp

type

Methods

toJSON

Parameters

Returns Record<string, any>

validate

Parameters

Returns Promise<void>

Throws

Settings

On This Page