Readonly
[スコープ解除]関連するオブジェクトの「を含む」環境バインディングから除外されているプロパティであるオブジェクト。
Optional
Readonly
[スコープ解除]?: ブール値'with' ステートメントで使用されたときに存在しない場合に、プロパティの値が「true」を持つオブジェクトです。
Optional
Length?: ブール値配列の長さを取得または設定します。 これは配列内の最上位のインデックスより 1 つ大きい数値です。
リスト内の値の数。
長さプロパティを割り当てることができないため、エラーが発生します。
null
はコレクションに対して有効な値であるかどうか。
null
はコレクションに対して有効な値であるかどうか。
アイテムのタイプの名前。
値の型の名前。
コレクション内のすべての値を反復処理するイテレータ。
ライブコレクション インスタンスが変更されたときに呼び出されるリスナーcallback
を追加します。
変更が発生したときに呼び出される関数。
Optional
keyPaths : string | string []リスナーに関連する変更の下限を示します。 これは下限値です。これは、複数のリスナーが追加されている場合(それぞれが独自のkeyPaths
を持つもの)、これらのキーパスの和集合によって、コレクションに登録されているすべてのリスナーに関連すると見なされる変更が決定されるためです。 言い換えれば、キーパスが異なる他のリスナーが存在する場合、キーパスで指定された数より多くのリスナーが起動する可能性があります。
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` オブジェクト。
コレクション内の値またはコレクション内のすべてのオブジェクト内の指定された プロパティの値の平均を計算します。コレクションが空の場合はundefined
です。
int、float、double プロパティでのみサポートされます。 このメソッドではnull
値は完全に無視され、平均に係数は考慮されません。
Optional
プロパティ: stringオブジェクトのコレクションの場合、プロパティは の平均になります。
の合計。
名前のプロパティが存在しない場合、またはプロパティが数値でない場合は、エラーが発生します。
Rest
...items : ConcatArray < T > []新しい配列に連結する配列や値。
この配列内のすべての要素に対して提供された関数を呼び出した結果を含む新しい配列。
Rest
...アイテム:( T | ConcatArray < T > ) []新しい配列に連結する配列や値。
この配列内のすべての要素に対して提供された関数を呼び出した結果を含む新しい配列。
true
コールバック関数がすべてのコレクション要素に対して真実の値を返す場合。それ以外の場合は、 false
。
述語 - 各要素についてテストする関数。
述語.値 - コレクション内で処理されている現在要素。
述語.インデックス - コレクション内で処理されている現在要素のインデックス。
述語.array - コレクションevery
が呼び出されました。
このArg - this
キーワードが述語関数内で参照できるオブジェクト。 thisArg
が省略されている場合、 undefined
はthis
値として使用されます。
Optional
このArg :任意のtrue
コールバック関数がすべてのコレクション要素に対して真実の値を返す場合。それ以外の場合は、 false
。
述語 - 各要素についてテストする関数。
述語.値 - コレクション内で処理されている現在要素。
述語.インデックス - コレクション内で処理されている現在要素のインデックス。
述語.array - コレクションevery
が呼び出されました。
このArg - this
キーワードが述語関数内で参照できるオブジェクト。 thisArg
が省略されている場合、 undefined
はthis
値として使用されます。
predicate
関数がtrue
を返したコレクションの要素を含む新しい配列。
述語 - 最大 3 つの引数を受け入れる関数。 filter
メソッドは、コレクション内の各要素に対してpredicate
関数を 1 回呼び出します。
述語.値 - コレクション内で処理されている現在要素。
述語.インデックス - コレクション内で処理されている現在要素のインデックス。
述語.array - コレクションfilter
が呼び出されました。
このArg - predicate
関数でthis
キーワードが参照できるオブジェクト。 thisArg
が省略されている場合、 undefined
はthis
値として使用されます。
Optional
このArg :任意のpredicate
関数がtrue
を返したコレクションの要素を含む新しい配列。
述語 - 最大 3 つの引数を受け入れる関数。 filter
メソッドは、コレクション内の各要素に対してpredicate
関数を 1 回呼び出します。
述語.値 - コレクション内で処理されている現在要素。
述語.インデックス - コレクション内で処理されている現在要素のインデックス。
述語.array - コレクションfilter
が呼び出されました。
このArg - predicate
関数でthis
キーワードが参照できるオブジェクト。 thisArg
が省略されている場合、 undefined
はthis
値として使用されます。
指定されたクエリによってフィルタリングされているこのコレクションを表す新しい結果を返します。
コレクションのオブジェクトをフィルタリングするために使用されるクエリ。
Rest
...args :不明[]後続の各引数はプレースホルダー(例: クエリ内の$0
、 $1
、 $2
、...)を含むドキュメントをインポートします。
提供されたクエリに従ってフィルタリングされた結果。
このメソッドに渡されたクエリまたはその他の引数が無効な場合は、 エラーが発生します。
これは現在、Realm オブジェクトのコレクションでのみサポートされています。
let merlots = wines.filtered('variety == "Merlot" && vintage <= $0', maxYear);
提供されたテスト関数を満たす、 配列の最初の要素の値。 それ以外の場合は、 undefined
が返されます。
述語 - 最大 3 つの引数を受け入れる関数。 find
メソッドは、コレクション内の各要素に対してpredicate
関数を 1 回呼び出します。
述語.値 - 要素の値。
述語.インデックス - 要素のインデックス。
述語.obj - 走査対象オブジェクト。
このArg - predicate
関数でthis
キーワードが参照できるオブジェクト。 thisArg
が省略されている場合、 undefined
はthis
値として使用されます。
Optional
このArg :任意の提供されたテスト関数を満たす、 配列の最初の要素の値。 それ以外の場合は、 undefined
が返されます。
述語 - 最大 3 つの引数を受け入れる関数。 find
メソッドは、コレクション内の各要素に対してpredicate
関数を 1 回呼び出します。
述語.値 - 要素の値。
述語.インデックス - 要素のインデックス。
述語.obj - 走査対象オブジェクト。
このArg - predicate
関数でthis
キーワードが参照できるオブジェクト。 thisArg
が省略されている場合、 undefined
はthis
値として使用されます。
Optional
このArg :任意の提供されたテスト関数を満たす、 配列内の最初の要素のインデックス。 それ以外の場合は、-1 が返されます。
述語 - 最大 3 つの引数を受け入れる関数。 findIndex
メソッドは、コレクション内の各要素に対してpredicate
関数を 1 回呼び出します。
述語.値 - 要素の値。
述語.インデックス - 要素のインデックス。
述語.obj - 走査対象オブジェクト。
このArg - predicate
関数でthis
キーワードが参照できるオブジェクト。 thisArg
が省略されている場合、 undefined
はthis
値として使用されます。
コールバック関数の結果であり、深度が 1 にフラット化された各要素を含む新しい配列。
コールバック - 新しい 配列の要素を生成し、3 つの引数を取る関数。
Callback.currentValue - 配列内で処理されている現在要素。
Callback.index - 配列内で処理されている現在要素のインデックス。
Callback.array - 配列flatMap
が呼び出されました。
このArg - コールバックを実行するときにこれとして使用する値。
Optional
このArg :任意のCallbackfn - 最大 3 つの引数を受け入れる関数。 forEach
は、コレクション内の各要素に対して Callbackfn 関数を 1 回呼び出します。
Callbackfn.value- コレクション内で処理されている現在要素。
Callbackfn.index - コレクション内で処理されている現在要素のインデックス。
Callbackfn.array - コレクションforEach
が呼び出されました。
このArg - callbackfn
関数でthis
キーワードが参照できるオブジェクト。 thisArg
が省略されている場合、 undefined
はthis
値として使用されます。
Optional
fromIndex :数値true
配列内にsearchElement
が見つかった場合、それ以外の場合は、 false
。
searchElement - 検索する要素。
fromIndex - この配列内のsearchElement
の検索を開始する位置。 負の値は、 array.Length + fromIndex のインデックスから asc で検索します。
fromIndex
は現在サポートされていません。 したがって、すべての検索はインデックス 0 から始まります。
Optional
fromIndex :数値コレクション内の特定の要素を見つけることができる最初のインデックス。存在しない場合は -1。
searchElement - コレクション内の検索する要素。
fromIndex - 検索を開始するコレクション インデックス。 省略した場合、検索はインデックス 0 から開始されます。
fromIndex
は現在サポートされていません。 したがって、すべての検索はインデックス 0 から始まります。
Optional
fromIndex :数値コレクション内の特定の要素が見つかる最後のインデックス。存在しない場合は -1。 コレクションはfromIndex
から逆方向に検索されます。
searchElement - コレクション内の検索する要素。
fromIndex - 検索を開始するコレクション インデックス。 省略した場合、検索は最後のインデックスから開始されます。
コレクション内の各要素callbackfn
関数を呼び出した結果を含む新しい配列。
Callbackfn - 最大 3 つの引数を受け入れる関数。 map
メソッドは、コレクション内の各要素に対してcallbackfn
関数を 1 回呼び出します。
Callbackfn.value- コレクション内で処理されている現在要素。
Callbackfn.index - コレクション内で処理されている現在要素のインデックス。
Callbackfn.array - コレクションmap
が呼び出されました。
このArg - callbackfn
関数でthis
キーワードが参照できるオブジェクト。 thisArg
が省略されている場合、 undefined
はthis
値として使用されます。
コレクション内の値、またはコレクション内のすべてのオブジェクト内の指定されたプロパティの最大値を返します。コレクションが空の場合はundefined
です。
int、float、double、date プロパティでのみサポートされます。 null
値はこのメソッドによって完全に無視され、返されません。
Optional
プロパティ: stringオブジェクトのコレクションの場合、 プロパティは最大 の値を取得します。
最大値。
名前を持つプロパティが存在しない場合、またはプロパティが数値または日付でない場合は、エラーが発生します。
コレクション内の値、またはコレクション内のすべてのオブジェクト内の指定されたプロパティの最小値を返します。コレクションが空の場合はundefined
です。
int、float、double、date プロパティでのみサポートされます。 null
値はこのメソッドによって完全に無視され、返されません。
Optional
プロパティ: stringオブジェクトのコレクションの場合、 プロパティは の最小値をとります。
最小値。
名前のプロパティが存在しない場合、またはプロパティが数値または日付でない場合は、 TypeAssertionErrorが発生します。
リストの 1 つの要素をあるインデックスから別のインデックスに移動します。
移動する要素のインデックス。
要素の宛先インデックス。
書込みトランザクション内ではない場合、または入力インデックスのいずれかが 0 未満またはリストのサイズ以上の場合、 AssertionError 。
リストから最後の値を削除して返します。
最後の値、またはリストが空の場合は未定義。
書込みトランザクション内でない場合は、 AssertionError 。
1 つ以上の値をリストの末尾に追加します。
Rest
...items : T []リストに追加する値。
値を追加した後のリストの新しい長さ。
値がリストに保存できるタイプではない場合、またはリストに追加されるオブジェクトがリストのObjectSchemaと一致しない場合は、{TypeError} が発生します。
書込みトランザクション内でない場合は、 AssertionError 。
削減の結果得られる値。
Callbackfn - 最大 4 つの引数を受け入れる関数。 reduce
メソッドは、コレクション内の各要素に対してcallbackfn
関数を 1 回呼び出します。
Callbackfn.previumValue - callbackfn
関数の最後の呼び出しで以前に返された値、またはinitialValue
(指定されている場合)。 (以下参照)。
Callbackfn.currentValue - コレクション内の現在処理中の要素。
Callbackfn.currentIndex - コレクション内で処理されている現在要素のインデックス。
Callbackfn.array - コレクションreduce
が呼び出されました。
initialValue - initialValue
が指定されている場合、それが累積を開始するための初期値として使用されます。 callbackfn
関数の最初の呼び出しでは、この値は要素値ではなく引数として提供されます。
削減の結果得られる値。
Callbackfn - 最大 4 つの引数を受け入れる関数。 reduce
メソッドは、コレクション内の各要素に対してcallbackfn
関数を 1 回呼び出します。
Callbackfn.previumValue - callbackfn
関数の最後の呼び出しで以前に返された値、またはinitialValue
(指定されている場合)。 (以下参照)。
Callbackfn.currentValue - コレクション内の現在処理中の要素。
Callbackfn.currentIndex - コレクション内で処理されている現在要素のインデックス。
Callbackfn.array - コレクションreduce
が呼び出されました。
initialValue - initialValue
が指定されている場合、それが累積を開始するための初期値として使用されます。 callbackfn
関数の最初の呼び出しでは、この値は要素値ではなく引数として提供されます。
削減の結果得られる値。
Callbackfn - 最大 4 つの引数を受け入れる関数。 reduce
メソッドは、コレクション内の各要素に対してcallbackfn
関数を 1 回呼び出します。
Callbackfn.previumValue - callbackfn
関数の最後の呼び出しで以前に返された値、またはinitialValue
(指定されている場合)。 (以下参照)。
Callbackfn.currentValue - コレクション内の現在処理中の要素。
Callbackfn.currentIndex - コレクション内で処理されている現在要素のインデックス。
Callbackfn.array - コレクションreduce
が呼び出されました。
initialValue - initialValue
が指定されている場合、それが累積を開始するための初期値として使用されます。 callbackfn
関数の最初の呼び出しでは、この値は要素値ではなく引数として提供されます。
削減の結果得られる値。
Array.prototype.reduceR right()
Callbackfn - 最大 4 つの引数を受け入れる関数。 reduceRight
メソッドは、コレクション内の各要素に対してcallbackfn
関数を 1 回呼び出します。
Callbackfn.previumValue - callbackfn
関数の最後の呼び出しで以前に返された値、またはinitialValue
(指定されている場合)。 (以下参照)。
Callbackfn.currentValue - コレクション内の現在処理中の要素。
Callbackfn.currentIndex - コレクション内で処理されている現在要素のインデックス。
Callbackfn.array - コレクションreduceRight
が呼び出されました。
initialValue - initialValue
が指定されている場合、それが累積を開始するための初期値として使用されます。 callbackfn
関数の最初の呼び出しでは、この値は要素値ではなく引数として提供されます。
削減の結果得られる値。
Array.prototype.reduceR right()
Callbackfn - 最大 4 つの引数を受け入れる関数。 reduceRight
メソッドは、コレクション内の各要素に対してcallbackfn
関数を 1 回呼び出します。
Callbackfn.previumValue - callbackfn
関数の最後の呼び出しで以前に返された値、またはinitialValue
(指定されている場合)。 (以下参照)。
Callbackfn.currentValue - コレクション内の現在処理中の要素。
Callbackfn.currentIndex - コレクション内で処理されている現在要素のインデックス。
Callbackfn.array - コレクションreduceRight
が呼び出されました。
initialValue - initialValue
が指定されている場合、それが累積を開始するための初期値として使用されます。 callbackfn
関数の最初の呼び出しでは、この値は要素値ではなく引数として提供されます。
削減の結果得られる値。
Array.prototype.reduceR right()
Callbackfn - 最大 4 つの引数を受け入れる関数。 reduceRight
メソッドは、コレクション内の各要素に対してcallbackfn
関数を 1 回呼び出します。
Callbackfn.previumValue - callbackfn
関数の最後の呼び出しで以前に返された値、またはinitialValue
(指定されている場合)。 (以下参照)。
Callbackfn.currentValue - コレクション内の現在処理中の要素。
Callbackfn.currentIndex - コレクション内で処理されている現在要素のインデックス。
Callbackfn.array - コレクションreduceRight
が呼び出されました。
initialValue - initialValue
が指定されている場合、それが累積を開始するための初期値として使用されます。 callbackfn
関数の最初の呼び出しでは、この値は要素値ではなく引数として提供されます。
指定されたインデックスにあるリストの要素を削除します。
削除する要素のインデックス。
書込みトランザクション(write transaction)内にない場合、または入力インデックスが 0 未満またはリストのサイズ以上の場合は、 AssertionError 。
コレクション インスタンスからリスナーcallback
を削除します。
以前にCollection.addListerメソッドを通じてリスナーとして追加されたコールバック関数。
callback
が関数でない場合は、 TypeAssertionErrorが発生します。
リストから最初の値を削除して返します。
最初の値、またはリストが空の場合はundefined
。
書込みトランザクション内でない場合は、 AssertionError 。
Optional
このArg :任意のtrue
コールバック関数が任意のコレクション要素に対して真実の値を返す場合。それ以外の場合は、 false
。
述語 - 各要素についてテストする関数。
述語.値 - コレクション内で処理されている現在要素。
述語.インデックス - コレクション内で処理されている現在要素のインデックス。
述語.array - コレクションevery
が呼び出されました。
このArg - this
キーワードが述語関数内で参照できるオブジェクト。 thisArg
が省略されている場合、 undefined
はthis
値として使用されます。
このコレクションのソートされたビューを表す新しい結果を返します。
Realm オブジェクトのコレクションは、それらのオブジェクトの 1 つ以上のプロパティ、またはそれらのオブジェクトにリンクされたオブジェクトのプロパティの 1 つ以上でソートできます。 1 つのプロパティで並べ替えるには、そのプロパティの名前をsorted()
に渡します。その後、並べ替えを元に戻すかどうかを示すブール値を任意で渡します。 複数のプロパティの場合、ソートするプロパティをリストするソート記述子の配列を渡す必要があります。
他の型のコレクションは、値のプロパティではなく、値自体にソートされるため、プロパティ名やソート記述子を指定する必要はありません。
Optional
逆:ブール値昇順ではなく降順でソートします。 descriptor
がソート記述子の配列である場合、適用されない可能性があります。
で渡された引数に従ってソートされた結果。
指定されたプロパティが存在しない場合は、 エラーが発生します。
このコレクションのソートされたビューを表す新しい結果を返します。
Realm オブジェクトのコレクションは、それらのオブジェクトの 1 つ以上のプロパティ、またはそれらのオブジェクトにリンクされたオブジェクトのプロパティの 1 つ以上でソートできます。 1 つのプロパティで並べ替えるには、そのプロパティの名前をsorted()
に渡します。その後、並べ替えを元に戻すかどうかを示すブール値を任意で渡します。 複数のプロパティの場合、ソートするプロパティをリストするソート記述子の配列を渡す必要があります。
他の型のコレクションは、値のプロパティではなく、値自体にソートされるため、プロパティ名やソート記述子を指定する必要はありません。
コレクションを並べ替えるプロパティ名。
で渡された引数に従ってソートされた結果。
指定されたプロパティが存在しない場合は、 エラーが発生します。
このコレクションのソートされたビューを表す新しい結果を返します。
Realm オブジェクトのコレクションは、それらのオブジェクトの 1 つ以上のプロパティ、またはそれらのオブジェクトにリンクされたオブジェクトのプロパティの 1 つ以上でソートできます。 1 つのプロパティで並べ替えるには、そのプロパティの名前をsorted()
に渡します。その後、並べ替えを元に戻すかどうかを示すブール値を任意で渡します。 複数のプロパティの場合、ソートするプロパティをリストするソート記述子の配列を渡す必要があります。
他の型のコレクションは、値のプロパティではなく、値自体にソートされるため、プロパティ名やソート記述子を指定する必要はありません。
コレクションを並べ替えるプロパティ名。
Optional
逆:ブール値で渡された引数に従ってソートされた結果。
指定されたプロパティが存在しない場合は、 エラーが発生します。
値を削除したり、新しい値を挿入したりして、リストの内容を変更します。
開始インデックス。 リストの長さより大きい場合、代わりに開始インデックスは長さに設定されます。 負の場合、開始インデックスはリストの末尾からカウントされます(例: list.length - index
)。
Optional
deleteCount :数値リストから削除する値の数。 指定されない場合、開始インデックスからリストの末尾までのすべての値が削除されます。
リストから削除された値を含む配列。 値が削除された場合、配列は空になります。
値を削除したり、新しい値を挿入したりして、リストの内容を変更します。
開始インデックス。 リストの長さより大きい場合、代わりに開始インデックスは長さに設定されます。 負の場合、開始インデックスはリストの末尾からカウントされます(例: list.length - index
)。
リストから削除する値の数。 指定されない場合、開始インデックスからリストの末尾までのすべての値が削除されます。
Rest
...items : T []リストに挿入する値は、 index
から追加されます。
リストから削除された値を含む配列。 値が削除された場合、配列は空になります。
2 つのインデックスでリストの要素の位置をスワップします。
最初の要素のインデックス。
2 番目の要素のインデックス。
書込みトランザクション内ではない場合、または入力インデックスのいずれかが 0 未満またはリストのサイズ以上の場合、 AssertionError 。
JSON シリアル化のプレーン オブジェクト表現。 @unap/ Structured-cloudやflatedなどの円形の JSON 直列化ライブラリを使用して、円形の構造を持つ Realm エンティティを文字列化します。
プレーン オブジェクトの配列。
リストの先頭に 1 つ以上の値を追加します。
Rest
...items : T []リストに追加する値。
値を追加した後のリストの新しい長さ。
値がリストに保存できるタイプではない場合、またはリストに追加されるオブジェクトがリストのObjectSchemaと一致しない場合は、{TypeError} が発生します。
書込みトランザクション内でない場合は、 AssertionError 。
コレクション内のすべての値を持つイテレータ。
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/values | Array.prototype.values()}
TypeDocを使用して生成
このクラスのインスタンスは、タイプが
"list"
であるオブジェクト プロパティにアクセスするときに返されます。リストはほとんど通常のJavaScript配列と同様に動作しますが、リストの
type
プロパティとoptional
プロパティによって示される単一のタイプの値のみを保存でき、書込みトランザクション内でのみ変更できます。