Class IGamePlayer

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

epicOnlineServicesId? gameId ip? name ping? platformId? steamId? xboxLiveId?

Methods

toJSON validate

Constructors

constructor

Properties

OptionalepicOnlineServicesId

epicOnlineServicesId?: string

gameId

gameId: string

Unique identifier for this player, as used by the game

Optionalip

ip?: string

name

name: string

The players username

Optionalping

ping?: number

OptionalplatformId

platformId?: string

OptionalsteamId

steamId?: string

OptionalxboxLiveId

xboxLiveId?: string

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