[]
        
(Showing Draft Content)

SharedDoc の初期化

js-collaboration-ot-client は、サーバーに接続して共有ドキュメント(SharedDoc)を作成し、リアルタイムでの共同編集を実現するためのクライアント側 API を提供します。このドキュメントでは、次の内容を含めてクライアントを初期化する方法を説明します。

  • 依存関係をインストールする

  • 接続を設定する

  • ドキュメントインスタンスを作成する

インストール

npm を使用して必要な依存パッケージをインストールします。

npm install @mescius/js-collaboration-client @mescius/js-collaboration-ot-client
  • js-collaboration-client: サーバーとの接続を確立するために使用する Client クラスと Connection クラスを提供します。

  • js-collaboration-ot-client: OT 機能と SharedDoc クラスを提供します。

初期化

  1. OT の型を登録する。

    オペレーションの挙動を定義するために「OT の型」を登録します。以下は、シンプルなテキストタイプを登録する例です。

    import { TypesManager } from '@mescius/js-collaboration-ot-client';
    
    const textType = {
        uri: '<http://example.com/types/text',>
        create: (data) => data || '', // 空の文字列として初期化する
        transform: (op1, op2, side) => {
            if (op1.pos > op2.pos || (op1.pos === op2.pos && side === 'left')) {
                return { pos: op1.pos + op2.text.length, text: op1.text };
            }
            return op1;
        },
        apply: (snapshot, op) => {
            return snapshot.slice(0, op.pos) + op.text + snapshot.slice(op.pos);
        }
    };
    
    TypesManager.register(textType);
  2. Client インスタンスを作成する。

    Client クラスを使用してクライアントインスタンスを作成し、サーバーアドレスを指定します。

    import { Client } from '@mescius/js-collaboration-client';
    const client = new Client();
  3. ルームに接続する。

    connect メソッドを使用してサーバー上の特定のルームに接続し、Connection オブジェクトを返します。

    const connection = client.connect('room1');
  4. SharedDoc を初期化する。

    SharedDoc クラスを使用して共有ドキュメントインスタンスを作成し、Connection にバインドします。SharedDoc は Connection を使用してメッセージを送受信します。メッセージタイプは 「ot-doc」 です。

    import { SharedDoc } from '@mescius/js-collaboration-ot-client';
    const doc = new SharedDoc(connection);

パラメータ:

connection: client.connect から返される Connection オブジェクト。

役割:

スナップショットの操作やオペレーションの送信に使用する共有ドキュメントインスタンスを作成します。

完全な例

以下は SharedDoc 初期化の完全な例です。

import { Client } from '@mescius/js-collaboration-client';
import { SharedDoc, TypesManager } from '@mescius/js-collaboration-ot-client';

// OT の型を定義する
const textType = {
    uri: 'rich-text-ot-type',
    create: (data) => data || '', // 空の文字列として初期化する
    transform: (op1, op2, side) => {
        if (op1.pos > op2.pos || (op1.pos === op2.pos && side === 'left')) {
            return { pos: op1.pos + op2.text.length, text: op1.text };
        }
        return op1;
    },
    apply: (snapshot, op) => {
        return snapshot.slice(0, op.pos) + op.text + snapshot.slice(op.pos);
    }
};

// OT の型を登録する
TypesManager.register(textType);

// クライアントを初期化する
const client = new Client();
const connection = client.connect('room1');
const doc = new SharedDoc(connection);

次の手順

ドキュメントを作成し、Op を送信/受信するには、「SharedDoc クラス 」を参照してください。