クラス: DocumentServices<S, T>

共同OTのためのドキュメントサービスを提供します。

Type parameters

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

Table of contents

コンストラクタ

• constructor

プロパティ

• db
• maxSubmitRetries
• milestoneDb
• submitSnapshotBatchSize

メソッド

• fetch
• fetchHistorySnapshot
• getOps
• on
• submit
• use

コンストラクタ

constructor

• new DocumentServices<S, T>(config?)

Type parameters

名前
S
T

パラメータ

名前	型
config?	IDocConfig<S, T>

プロパティ

db

• db: IDatabaseAdapter<S, T>

ドキュメントデータを保存するためのデータベースアダプタ。

template スナップショットデータのタイプ。

template 操作データのタイプ。

---

maxSubmitRetries

• オプション maxSubmitRetries: number

操作を送信するときの最大再試行回数。

default undefined -試行回数制限なし。

---

milestoneDb

• milestoneDb: IMilestoneDatabaseAdapter<S>

スナップショットマイルストーンのマイルストーンデータベースアダプタ。

template スナップショットデータのタイプ。

---

submitSnapshotBatchSize

• submitSnapshotBatchSize: number

スナップショットを実行依頼するときのスナップショットのバッチサイズ。

default 100

メソッド

fetch

▸ fetch(id, context?): Promise<ISnapshot<S>>

ドキュメントの最新のスナップショットを取得します。

パラメータ

名前	型	説明
id	string	ドキュメントのID。
context?	IContext	-

戻り値

Promise<ISnapshot<S>>

ドキュメントスナップショットを解決するプロミス。

---

fetchHistorySnapshot

▸ fetchHistorySnapshot(id, version?, context?): Promise<ISnapshot<S>>

ドキュメントのスナップショット履歴をバージョン別に取得します。

パラメータ

名前	型	説明
id	string	ドキュメントのID。
version?	number	-
context?	IContext	-

戻り値

Promise<ISnapshot<S>>

スナップショット履歴を解決するプロミス。

---

getOps

▸ getOps(id, from, to?, context?): Promise<IOp<T>[]>

2つのバージョン間の操作を取得します（'from'を含む、'to'を除く）。

パラメータ

名前	型	説明
id	string	ドキュメントのID。
from	number	開始するバージョン。
to?	number	-
context?	IContext	-

戻り値

Promise<IOp<T>[]>

操作の配列を解決するプロミス。

---

on

▸ on<K>(hookName, hook): void

ドキュメントサービス内の特定のイベントのフックを登録します。

Type parameters

名前	型	説明
K	IDocHookContextのキーを拡張します。	フック名のタイプ。IDocHookContextのキーを拡張したもの。

パラメータ

名前	型	説明
hookName	K	登録するフックの名前。
hook	IHook<IDocHookContext[K]>	登録するフック。

戻り値

void

---

submit

▸ submit(id, op, context?): Promise<IOp<T>[]>

ドキュメントに操作を送信します（、、またはフィールドを含める必要があります）。

パラメータ

名前	型	説明
id	string	ドキュメントのID。
op	IOp<T>	送信する操作。
context?	IContext	-

戻り値

Promise<IOp<T>[]>

操作結果を解決するプロミス。

---

use

▸ use<K>(action, middleware): void

ドキュメントサービス内の特定のアクションのミドルウェアを登録します。

Type parameters

名前	型	説明
K	IDocMiddlewareContext<S, T>のキーを拡張します。	アクション名のタイプ。IDocMiddlewareContext<S, T>のキーを拡張したもの。

パラメータ

名前	型	説明
action	K	ミドルウェアに関連付けるアクションの名前。。
middleware	IMiddleware<IDocMiddlewareContext<S, T>[K]>	登録するミドルウェア。

戻り値

void