Alier.message()

メッセージオブジェクトを作成します。

メッセージオブジェクトとは情報の伝達に利用されるオブジェクトです。画面操作やイベントの発生時に、メッセージオブジェクトを作成して送ります。メッセージオブジェクトを受け取った側はメッセージオブジェクトから情報をとりだして処理します。

作成したメッセージオブジェクトは以下のメソッドに渡すことができます。

構文

Alier.message(id, code, param, origin) => { id, code, param, origin }

引数

  • id: string | null

    メッセージの識別子です。メッセージの処理を決めるために利用されます。

  • code: string | null

    メッセージの追加の識別子です。idとは別でメッセージの処理を決めるために利用されます。

  • param: any

    メッセージに含めるパラメータです。

  • origin: any

    メッセージの発信源です。メッセージを中継したときに、どこから発信されたか特定するために利用されます。

返値: { id, code, param, origin }

引数をまとめたメッセージオブジェクトです。

  • id: string | null
  • code: string | null
  • param: any
  • origin: any

例

const myEvent = new MessagePorter();
const myMessage = Alier.message("foo", "bar", { key:"value" }, null);
myEvent.post(myMessage);