codyfight-widget-ui-type

Description

Types declaration file for Widget -> UI events payload.

https://www.npmjs.com/package/codyfight-widget-ui-type

Installation

This package can be installed via npm or yarn:

npm install codyfight-widget-ui-type --save-dev

or

yarn add codyfight-widget-ui-type -D

Usage

import type { GameConfigEvent, GameState } from "codyfight-widget-ui-type";

// Example usage of exported types

function handleGameState(event: GameState) {
  // Do something with event.detail.value
}

function handleGameConfig(event: GameConfigEvent) {
  // Do something with event.detail.value.toggleSound
}

Updating types

In order to update the types, follow these steps:

1. Clone the repository
2. Run npm install
3. Update the src/index.ts file
4. Update the package version in package.json
5. Run npm run build
6. Run npm publish
7. Commit and push the changes

Make sure to log in to npm before publishing the package:

npm login

Make sure to always have the latest version of the package installed in your project:

{
  "devDependencies": {
    "codyfight-widget-ui-type": "^1.0.0"
  }
}

yarn upgrade codyfight-widget-ui-type --latest

or

npm update codyfight-widget-ui-type --latest