クラス辞書[T次]<T>

このクラスのインスタンスは、型が次のオブジェクト プロパティにアクセスするときに返されます: "Dictionary"

辞書は、キーが string であるキーと値のペアとして、ほとんど JavaScript オブジェクトと同様に動作します。

型パラメータ

  • T =不明

階層(完全に表示

インデックス作成可能

[ key: string ]: T

@ts-expect-error キーのエンドユーザー名前空間でメソッドを公開しています

メソッド

  • ライブコレクション インスタンスが変更されたときに呼び出されるリスナーcallbackを追加します。

    パラメーター

    • コールバック:辞書変更コールバック

      変更が発生したときに呼び出される関数。

    • Optional keyPaths : string | string []

      リスナーに関連する変更の下限を示します。 これは下限値です。これは、複数のリスナーが追加されている場合(それぞれが独自のkeyPathsを持つもの)、これらのキーパスの和集合によって、コレクションに登録されているすべてのリスナーに関連すると見なされる変更が決定されるためです。 言い換えれば、キーパスが異なる他のリスナーが存在する場合、キーパスで指定された数より多くのリスナーが起動する可能性があります。

    Returns void

    注意

    deletions and oldModifications report the indices in the collection before the change happened, while挿入and newModifications report the indices into the new version of the collection. @throws A {@link TypeAssertionError} ifコールバック is not a function. @example wines.addListener((collection, changes) => { // collection === wines console.log( ${changes.insertions.Length} 挿入); console.log( ${changes. oldModifications.Length} oldModifications ); console.log( ${changes.newModifications.Length} newModifications ); console.log( ${changes.deletions.Length} 削除); console.log(コレクションの新しいサイズ: ${collection.Length} ); }); @example wines.addListener((collection, changes) => { console.log("A wine's brand might have changed"); }, ["brand"]); @note Adding the listener is an asynchronous operation, so the callback is invoked the first time to notify the caller when the listener has been added. Thus, when the callback is invoked the first time it will contain empty arrays for each property in the Changes` オブジェクト。

  • この辞書が削除されておらず、有効な Realm の一部であるかどうかを確認します。

    ブール値を返します

    true 辞書に安全にアクセスできる場合は、。

    以来

    0.14.0 @ts-expect-error エンドユーザーのキーの名前空間でメソッドを公開しています

  • 指定されたキーとともに、辞書から要素を削除します。 これは、キーがすでに辞書にない場合は、スローしません。

    パラメーター

    • キー: string | string []

      削除するキー。

    これを返します

    辞書

    スロー

    書込みトランザクション内でない場合は、 AssertionError

    以来

    10.6.0 @ts-expect-error エンドユーザーのキーの名前空間でメソッドを公開しています

  • コレクション インスタンスからリスナーcallbackを削除します。

    パラメーター

    • コールバック:辞書変更コールバック

      以前にCollection.addListerメソッドを通じてリスナーとして追加されたコールバック関数。

    Returns void

    スロー

    callbackが関数でない場合は、 TypeAssertionErrorが発生します。

  • 指定されたキーと値を持つ 1 つ以上の要素を辞書に追加するか、キーが存在する場合は値を更新します。

    パラメーター

    • 要素: {
          [キー: string ] : T
      }

      追加する要素のオブジェクト。

      • [key : string ]: T

    これを返します

    辞書。

    スロー

    AssertionError書込みトランザクション内ではない場合、入力オブジェクトにはシンボル キーが含まれます。また、値が 型の制約 に違反している場合は、入力オブジェクトにシンボル キーが含まれます。

    以来

    10.6.0 @ts-expect-error エンドユーザーのキーの名前空間でメソッドを公開しています

  • 指定されたキーと値を持つ要素を辞書に追加するか、キーが存在する場合は値を更新します。

    パラメーター

    • キー: string

      追加する要素のキー。

    • : T

      追加する要素の値。

    これを返します

    辞書。

    スロー

    書込みトランザクション内ではない場合、キーは シンボル または、値が型制約に違反している場合は になります。

    以来

    12.0.0

TypeDocを使用して生成