クラス: SharedDoc<S, T>

スナップショットと操作を要求するための共有ドキュメントを表します。

Type parameters

名前	型	説明
S	unknown	スナップショットデータのタイプ。
T	unknown	操作データのタイプ。

Table of contents

コンストラクタ

• constructor

アクセサー

• connection
• data
• id
• type
• version

メソッド

• create
• del
• destroy
• fetch
• fetchHistorySnapshot
• hardRollback
• off
• on
• once
• restore
• submitOp
• subscribe

コンストラクタ

constructor

• new SharedDoc<S, T>(conn)

新しい共有ドキュメントのインスタンスを作成します。

Type parameters

名前	型
S	unknown
T	unknown

パラメータ

名前	型
conn	Connection

アクセサー

connection

• get connection(): Connection

共有ドキュメントに関連付けられている接続を取得します。

戻り値

Connection

接続インスタンス。

---

data

• get data(): undefined | S

現在のスナップショットのデータを取得します。

戻り値

undefined | S

---

id

• get id(): string

共有ドキュメントのIDを取得します。

戻り値

string

ドキュメントID。

---

type

• get type(): undefined | OT_Type<S, T>

スナップショットのOTタイプ。

戻り値

undefined | OT_Type<S, T>

---

version

• get version(): undefined | number

現在のスナップショットのデータを取得します。

戻り値

undefined | number

メソッド

create

▸ create(data, type, options): Promise<void>

新しいドキュメントを作成します。

パラメータ

名前	型	説明
data	S	スナップショットの初期化に使用されるデータ。
type	string	OTタイプのURI。
options	IOptions	操作のオプション。

戻り値

Promise<void>

ドキュメントが作成された後に解決されるPromise。

---

del

▸ del(options): Promise<void>

ドキュメントを削除します。

パラメータ

名前	型	説明
options	IOptions	opのオプション。

戻り値

Promise<void>

ドキュメントが削除された後に解決されるプロミス。

---

destroy

▸ destroy(): void

オブザーバブルを破棄し、リソースをクリーンアップします。

戻り値

void

---

fetch

▸ fetch(): Promise<void>

スナップショットデータを取得します。

戻り値

Promise<void>

スナップショットが取得された後に解決されるプロミス。取得されたスナップショットデータは'doc.data'であります。

---

fetchHistorySnapshot

▸ fetchHistorySnapshot(options): Promise<ISnapshot<S>>

スナップショットデータ履歴を取得します。

パラメータ

名前	型	説明
options	IHistorySnapshotRequestOptions	スナップショット要求履歴のオプション。

戻り値

Promise<ISnapshot<S>>

スナップショット履歴が取得された後に解決されるPromise。

---

hardRollback

▸ hardRollback(): Promise<void>

スナップショットデータを最新バージョンにハードロールバックします。

戻り値

Promise<void>

ロールバックが完了したときに解決するPromise。

---

off

▸ off<NAME>(name, f): void

指定したイベントのリスナーを削除します。

Type parameters

名前	型	説明
NAME	ISharedDocEvents<S, T>のキーを拡張します。	イベント名のタイプ。ISharedDocEvents<S, T>のキーを拡張したもの。

パラメータ

名前	型	説明
name	NAME	イベント名。
f	ISharedDocEvents<S, T>[NAME]	削除するイベントハンドラ関数。

戻り値

void

---

on

▸ on<NAME>(name, f): ISharedDocEvents<S, T>[NAME]

指定したイベントのリスナーを登録します。

Type parameters

名前	型	説明
NAME	ISharedDocEvents<S, T>のキーを拡張します。	イベント名のタイプ。ISharedDocEvents<S, T>のキーを拡張したもの。

パラメータ

名前	型	説明
name	NAME	イベント名。
f	ISharedDocEvents<S, T>[NAME]	イベントハンドラ関数。

戻り値

ISharedDocEvents<S, T>[NAME]

イベントハンドラを登録します。。

---

once

▸ once<NAME>(name, f): void

指定したイベントの 1 回限りのリスナーを登録します。

Type parameters

名前	型	説明
NAME	ISharedDocEvents<S, T>のキーを拡張します。	イベント名のタイプ。ISharedDocEvents<S, T>のキーを拡張したもの。

パラメータ

名前	型	説明
name	NAME	イベント名。
f	ISharedDocEvents<S, T>[NAME]	一度呼び出されるイベントハンドラー関数。

戻り値

void

---

restore

▸ restore(targetVersion, options?): Promise<void>

ドキュメントを特定のバージョンに復元します。

パラメータ

名前	型	説明
targetVersion	number	復元する対象バージョン番号。
options?	IOptions	opのオプション。

戻り値

Promise<void>

ドキュメントが復元された後に解決されるプロミス。

---

submitOp

▸ submitOp(component, options?): Promise<void>

ドキュメントに操作を送信します。

パラメータ

名前	型	説明
component	T	操作コンポーネント。
options?	IOptions	-

戻り値

Promise<void>

操作が送信された後に解決されるPromise。

---

subscribe

▸ subscribe(): Promise<void>

スナップショットデータを登録すします。

戻り値

Promise<void>

スナップショットが登録された後に解決されるプロミス。登録されたスナップショットデータは'doc.data'であります。