インストール

モジュールをインストールします 

  1. npm install @wordpress/sync --save

API

connectIndexDb

IndexedDB永続プロバイダーへの接続機能。

パラメータ

  • objectId ObjectID: オブジェクトID。
  • objectType ObjectType: オブジェクトタイプ。
  • doc CRDTDoc: CRDTドキュメント。

戻り値

  • Promise<() => void>: 接続が確立されたときに解決されるPromise。

createSyncProvider

同期プロバイダーを作成します。

パラメータ

  • connectLocal ConnectDoc: ドキュメントをローカルデータベースに接続します。
  • connectRemote ConnectDoc: ドキュメントをリモート同期接続に接続します。

戻り値

  • SyncProvider: 同期プロバイダー。

createWebRTCConnection

新しいWebRTC接続を作成する関数。

パラメータ

  • config Object: オブジェクトID。
  • config.signaling Array<string>:
  • config.password string:

戻り値

  • Function: 接続が確立されたときに解決されるPromise。

このパッケージへの貢献

これはGutenbergプロジェクトの一部である個別のパッケージです。このプロジェクトはモノレポとして整理されています。特定の目的を持つ複数の自己完結型ソフトウェアパッケージで構成されています。このモノレポ内のパッケージはnpmに公開され、WordPressや他のソフトウェアプロジェクトで使用されています。

このパッケージやGutenberg全体への貢献について詳しく知りたい場合は、プロジェクトの主な貢献者ガイドをお読みください。