Class EventChatMessage

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)

Constructors

constructor

Properties

channel msg player? timestamp type

Methods

toJSON validate

Constructors

constructor

Properties

channel

channel: ChatChannel

msg

msg: string

Optionalplayer

player?: IGamePlayer

timestamp

timestamp: string = ...

type

type: "chat-message" = GameEvents.CHAT_MESSAGE

Methods

toJSON

  • toJSON(): Record<string, any>

  • Returns Record<string, any>

validate

  • validate(extraOpts?: ValidatorOptions): Promise<void>

  • Validates the DTO instance

    Parameters

    • OptionalextraOpts: ValidatorOptions

    Returns Promise<void>

    Throws

    if validation fails

Settings

Member Visibility

On This Page

Constructors
Properties
Methods