Class BaseTakaroEvent<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

Hierarchy (View Summary)

BaseEvent<T>
- BaseTakaroEvent

Index

Constructors

constructor

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

Properties

msg

msg: string

timestamp

timestamp: string = ...

type

type: ValueOf<
    {
        COMMAND_EXECUTED: "command-executed";
        COMMAND_EXECUTION_DENIED: "command-execution-denied";
        CRONJOB_EXECUTED: "cronjob-executed";
        CURRENCY_ADDED: "currency-added";
        CURRENCY_DEDUCTED: "currency-deducted";
        CURRENCY_RESET_ALL: "currency-reset-all";
        GAMESERVER_CREATED: "gameserver-created";
        GAMESERVER_DELETED: "gameserver-deleted";
        GAMESERVER_UPDATED: "gameserver-updated";
        HOOK_EXECUTED: "hook-executed";
        MODULE_CREATED: "module-created";
        MODULE_DELETED: "module-deleted";
        MODULE_INSTALLED: "module-installed";
        MODULE_UNINSTALLED: "module-uninstalled";
        MODULE_UPDATED: "module-updated";
        PLAYER_BANNED: "player-banned";
        PLAYER_CREATED: "player-created";
        PLAYER_DELETED: "player-deleted";
        PLAYER_LINKED: "player-linked";
        PLAYER_NEW_IP_DETECTED: "player-new-ip-detected";
        PLAYER_NEW_NAME_DETECTED: "player-new-name-detected";
        PLAYER_UNBANNED: "player-unbanned";
        ROLE_ASSIGNED: "role-assigned";
        ROLE_CREATED: "role-created";
        ROLE_DELETED: "role-deleted";
        ROLE_REMOVED: "role-removed";
        ROLE_UPDATED: "role-updated";
        SERVER_STATUS_CHANGED: "server-status-changed";
        SETTINGS_SET: "settings-set";
        SHOP_LISTING_CREATED: "shop-listing-created";
        SHOP_LISTING_DELETED: "shop-listing-deleted";
        SHOP_LISTING_UPDATED: "shop-listing-updated";
        SHOP_ORDER_CREATED: "shop-order-created";
        SHOP_ORDER_DELIVERY_FAILED: "shop-order-delivery-failed";
        SHOP_ORDER_STATUS_CHANGED: "shop-order-status-changed";
    },
>

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 BaseTakaroEvent<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BaseTakaroEvent<T>

Properties

msg

timestamp

type

Methods

toJSON

Parameters

Returns Record<string, any>

validate

Parameters

Returns Promise<void>

Throws

Settings

On This Page