AlierView: post()

対象の AlierView に取り付けられた ViewLogic にメッセージを送ります。

構文

alierView.post(message) => Promise<boolean>
alierView.post(message, options) => Promise<boolean>

引数

• message: object

  送信するメッセージです。 このオブジェクトは以下のプロパティを持ちます：

  • id: string | null

    メッセージの識別子です。

  • code: string | null

    メッセージの追加の識別子です。

  • param: any | null

    メッセージが持つパラメータです。

  • origin: object | null

    メッセージの生成元です。

• oprions: object （省略可）

  送信するメッセージに関するオプションです。 このオブジェクトは以下のプロパティを持ちます：

  • discardDuplicates: boolean

    メッセージの滞留制御のフラグです。 true の場合、 id と code が同一の処理中のメッセージがある場合は message を受け取りません。 デフォルトは false です。

返値: Promise<boolean>

送信したメッセージが消費されたかどうかを解決時に示すプロミスです。 true として解決された場合、メッセージが消費されたことを示し、false なら消費されなかったことを示します。

例外

• TypeError
  • 引数 message が非 null のオブジェクトでなかった場合。

例

const recipient = new class extends ViewLogic {
    constructor() {
        super();
        this.loadContainer({
            text: `<div id="hello"><p>Hello!</p></div>`,
            id: "hello"
        });
        this.relateElements(this.collectElements(this.container));
    }

    async messageHandler(message) {
        message.deliver({
            post: message => {
                //  Alier.View に対して送られたメッセージを処理する
                console.log(
                    `id = ${ message.id}`,
                    `code = ${message.code}`,
                    `param = ${message.param}`
                );
            },
        });
    }
};

//  recipient を Alier.View へ取り付ける
Alier.View.attach(recipient);

//  Alier.View にメッセージを送る。
//  メッセージは recipient へ送られる。
Alier.View.post(Alier.message("post", "sent", "message"));
//  ==> "id = post" "code = sent" "param = message"

解説

AlierView に取り付けられている ViewLogic にメッセージを送ります。

取り付けられている ViewLogic がなければこの関数は何も行いません。

この関数は本質的に、alierView.logic?.post(message) の簡略記法です。logic が存在する場合、その結果は ViewLogic の post() に従います。