タイプ エイリアス SubscriptionOptions

サブスクリプション オプション: {
    動作?: WaitForSync;
    name?: string;
    スローオンアップデート?: ブール値;
    タイムアウト?: 数値;
}

MutableSubscriptionSet.addのオプション。

型宣言

  • Optional 動作?: WaitForSync

    サブスクライブ オブジェクトがダウンロードされるまで待機する方法、または待機しない方法を指定します。

    default

    WaitForSync.FirstTime
    
  • Optional name?: string

    追加されるサブスクライブの名前を設定します。 これにより、後でMutableSubscriptionSet.removeByNameを呼び出す際など、サブスクリプションを名前で参照することができます。

  • Optional スロー時更新?: ブール値

    デフォルトでは、既存のサブスクライブと同じ名前で異なるクエリを実行することで、既存のサブスクライブが新しいクエリで更新されます。 throwOnUpdateが true に設定されている場合、同じ名前で異なるクエリのサブスクリプションを追加すると、代わりに例外がスローされます。 同じ名前とクエリを持つサブスクリプションを追加しても、常に何も発生しません。

  • Optional タイムアウト?: 数値

    オブジェクトがダウンロードされるまで待機する最大時間(ミリ秒単位)。 時間がこの制限を超えると、 Resultsが返され、ダウンロードはバックグラウンドで続行されます。

TypeDocを使用して生成