NarraLeaf

Namespace\<T extends NameSpaceContent\<keyof T\>\>

Storable の名前空間内で値を設定・取得・比較・リセットする Namespace のメソッド

Namespace は、Storable の名前空間を表すクラスです。

setassignreset を通じたすべての書き込みは、登録先のストアへ報告され、ホストはそれに反応 できます。参照: 保存された値を監視する。 購読はここではなく Storable の上で行ってください。newGame() とセーブの読み込みは、どちらも Namespace オブジェクトを置き換えます。

公開プロパティ

name

  • string - 名前空間の可読名

公開メソッド

constructor

  • name: string - 名前空間の可読名
  • initContent: T - 名前空間の初期内容
  • key?: string - 名前空間のキー。デフォルトは name

set<Key extends keyof T>

例:

const namespace = new Namespace<{name: string}>('player1', {name: 'John Doe'});

namespace.set('name', 'Jane Smith');
  • key: Key - 設定する値のキー
  • value: T[Key] - 設定する値
  • 返り値: this

get<Key extends keyof T = any>

  • key: Key - 取得する値のキー
  • 返り値: T[Key]

equals<Key extends keyof T = any>

  • key: Key - 比較する値のキー
  • value: T[Key] - 比較する値
  • 返り値: boolean

assign

  • values: Partial<T> - 割り当てる内容
  • 返り値: this

has

  • key: keyof T - 確認するキー
  • 返り値: boolean

keys

  • 返り値: (keyof T)[]

values

  • 返り値: T[keyof T][]

entries

  • 返り値: [keyof T, T[keyof T]][]

reset

名前空間を初期内容にリセットします。

  • 返り値: this

このページの目次