現在ドキュメントは制作段階にあるため、多くの情報が不完全なものになっています

報告は Discord までお願いします

シグナル

概要

アプリ間で任意のデータで通知し合う事ができます

定義

omu.signals.json<T>(name)
から定義することができます

  • T?: メッセージの型
  • name: シグナルの名前。同じ名前で複数のシグナルを作ることはできません

以下が定義例です

1 
type MySignal = {
2 
    field1: string;
3 
    field2: number;
4 
}
5
6 
// シグナルの定義
7 
const mySignal = omu.signals.json<MySignal>('my_signal');

シグナルの送信

.notify(body)

  • body: 送るメッセージ
1 
// シグナルを送信する
2 
await mySignal.notify({
3 
    field1: 'Hello',
4 
    field2: 123,
5 
});

シグナルの受信

.listen(callback)

  • callback: データを引数に取る関数
1 
// シグナルを受信する
2 
mySignal.listen((signal) => {
3 
    console.log(signal.field1);
4 
    console.log(signal.field2);
5 
});
使用するパッケージマネージャー