NarraLeaf
NarraLeaf DesktopMain

Main

Electron の主プロセスランタイム、設定、ウィンドウ、ユーザーイベント、hooks、ストレージ

Main モジュールは、NarraLeaf の Electron 主プロセス側の窓口です。アプリケーションホストを作成し、メインウィンドウを起動し、renderer のイベントブリッジを接続し、アプリのデータパスを管理し、セーブおよび JSON ストレージ用の helpers を公開します。

import { AppConfig } from "narraleaf";

const app = new AppConfig().create();

app.onReady(() => {
    void app.launchApp();
});

エントリポイント

同じ安定した窓口は narraleafnarraleaf/main のどちらからでも利用できます。

import {
    App,
    AppConfig,
    AppWindow,
    assertSafeStorageKey,
} from "narraleaf";

ガイド

ユーザー向けのエクスポート

  • App:Electron のアプリケーションホスト。
  • AppConfigApp を作成するための連鎖可能な設定ビルダー。
  • AppWindowapp.launchApp() が返す BrowserWindow のラッパー。
  • StoreProvider:カスタムのセーブバックエンド用の型。
  • assertSafeStorageKeyMAX_STORAGE_KEY_LENGTH:セーブ id と JSON ストアの名前を検証する helpers。

Main Events

アプリレベルの renderer から main への呼び出しは、main 側で AppWindow.handleUserEvent() を使ってハンドラを登録し、renderer 側では requestMain() または invokeMainEvent() で呼び出します。

低レベルの契約型

このパッケージは、IPCEventTypeNamespaceIPCEventsRequestStatus といった低レベルの IPC 契約型もエクスポートしています。これらは NarraLeaf の組み込み preload ブリッジとデフォルトのハンドラを記述するものです。通常のアプリ機能では、これらをインポートする必要はほとんどありません。

このページの目次