api-types

RPGアツマールのゲームプレイヤー実行時に参照可能なグローバルオブジェクトRPGAtsumaruの型定義です。

typescriptのプロジェクトで使用する

コマンドライン上で以下を実行します。 実行にはnpm(https://www.npmjs.com/)が必要です。

npm install -D atsumaru/api-types#master

tsconfig.json に依存を書く場合

tsconfig.jsonのtypesを以下に設定します。types以外の項目は省略して表記しています。

{
    "compilerOptions": {
        "types": ["@atsumaru/api-types"]
    }
}

こうすることで、プロジェクト中で window.RPGAtsumaru の型定義を利用することができるようになります。

if (window.RPGAtsumaru) {
  ...
}

ファイル中で import を行う場合

または、以下のように、コード中から直接依存することもできます。

import "@atsumaru/api-types";

if (window.RPGAtsumaru) {
  ...
}

内部の型の利用する場合

以下のようにすることでRPGアツマールが内部で利用している型を使うこともできます。

import AtsumaruTypes from "@atsumaru/api-types";

const record = AtsumaruTypes.ScoreRecord = ...;

または

import { ScoreRecord } from "@atsumaru/api-types";

const record = ScoreRecord = ...;

テストについて

以下のコマンドでテストができます。このリポジトリにプルリクエストを送る際は 必ず テストが通ることを確認してください。

npm run test