Readonly
[unscopes]一个对象,其 true 属性是从关联对象的 'with' 环境绑定中排除的属性。
Optional
Readonly
[unscopes]?: 布尔一个对象,其属性的值为“true”,但在“with”语句中使用时,这些对象将不存在。
Optional
长度?: 布尔获取或设置数组的长度。 该数字比数组中的最高索引大 1。
值的数量。
由于无法分配长度属性,因此出现错误。
null
是否为collection的有效值。
null
是否为collection的有效值。
项目类型的名称。
值类型的名称。
一个迭代器,用于遍历collection中的所有值。
添加监听器callback
,当实时collection实例发生更改时将调用该监听器。
发生更改时要调用的函数。
Optional
keyPaths : string | string []指示与侦听器相关的更改的下限。 这是一个下限,因为如果添加了多个侦听器(每个侦听器都有自己的keyPaths
),这些键路径的并集将确定被视为与在collection上注册的所有侦听器相关的更改。换言之:如果存在具有不同键路径的其他侦听器,则侦听器触发的次数可能会超过键路径指定的次数。
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
更改` 对象。
Rest
...items : ConcatArray < T > []要连接成新数组的数组和/或值。
一个新数组,其中包含对此数组中每个元素调用所提供函数的结果。
Rest
...items : ( T | ConcatArray < T > ) []要连接成新数组的数组和/或值。
一个新数组,其中包含对此数组中每个元素调用所提供函数的结果。
true
如果回调为每个collection元素返回一个真值;否则为false
。
predicate - 用于测试每个元素的函数。
predicate.value — collection中正在处理的当前元素。
predicate.index - 集合中正在处理的当前元素的索引。
predicate.array — 调用了collectionevery
。
thisArg - this
关键字可以在谓词函数中引用的对象。 如果省略thisArg
,则将undefined
用作this
值。
Optional
thisArg : anytrue
如果回调为每个collection元素返回一个真值;否则为false
。
predicate - 用于测试每个元素的函数。
predicate.value — collection中正在处理的当前元素。
predicate.index - 集合中正在处理的当前元素的索引。
predicate.array — 调用了collectionevery
。
thisArg - this
关键字可以在谓词函数中引用的对象。 如果省略thisArg
,则将undefined
用作this
值。
一个新数组,其中包含predicate
函数返回true
的collection元素。
谓词 - 最多接受三个参数的函数。 filter
方法为collection中的每个元素调用predicate
函数一次。
predicate.value — collection中正在处理的当前元素。
predicate.index - 集合中正在处理的当前元素的索引。
predicate.array — 调用了collectionfilter
。
thisArg - this
关键字可以在predicate
函数中引用的对象。 如果省略thisArg
,则使用undefined
作为this
值。
Optional
thisArg : any一个新数组,其中包含predicate
函数返回true
的collection元素。
谓词 - 最多接受三个参数的函数。 filter
方法为collection中的每个元素调用predicate
函数一次。
predicate.value — collection中正在处理的当前元素。
predicate.index - 集合中正在处理的当前元素的索引。
predicate.array — 调用了collectionfilter
。
thisArg - this
关键字可以在predicate
函数中引用的对象。 如果省略thisArg
,则使用undefined
作为this
值。
返回表示此collection按所提供的查询进行筛选的新结果。
用于从collection中筛选对象的查询。
Rest
...args : unknown []每个后续参数都由占位符使用(例如 $0
、 $1
、 $2
、...)在查询中。
根据提供的查询筛选结果。
如果传递给该方法的查询或任何其他参数无效,则出现错误。
目前仅 Realm 对象集合支持此功能。
let merlots = wines.filtered('variety == "Merlot" && vintage <= $0', maxYear);
数组中满足所提供测试函数的第一个元素的值。 否则,返回undefined
。
谓词 - 最多接受三个参数的函数。 find
方法为collection中的每个元素调用predicate
函数一次。
predicate.value — 元素的值。
predicate.index - 元素的索引。
predicate.obj - 正在遍历的对象。
thisArg - this
关键字可以在predicate
函数中引用的对象。 如果省略thisArg
,则使用undefined
作为this
值。
Optional
thisArg : any数组中满足所提供测试函数的第一个元素的值。 否则,返回undefined
。
谓词 - 最多接受三个参数的函数。 find
方法为collection中的每个元素调用predicate
函数一次。
predicate.value — 元素的值。
predicate.index - 元素的索引。
predicate.obj - 正在遍历的对象。
thisArg - this
关键字可以在predicate
函数中引用的对象。 如果省略thisArg
,则使用undefined
作为this
值。
Optional
thisArg : any数组中满足所提供测试函数的第一个元素的索引。 否则,返回 -1。
谓词 - 最多接受三个参数的函数。 findIndex
方法为collection中的每个元素调用predicate
函数一次。
predicate.value — 元素的值。
predicate.index - 元素的索引。
predicate.obj - 正在遍历的对象。
thisArg - this
关键字可以在predicate
函数中引用的对象。 如果省略thisArg
,则使用undefined
作为this
值。
Optional
thisArg : anycallbackfn — 最多接受三个参数的函数。 forEach
为collection中的每个元素调用一次 callbackfn 函数。
callbackfn.value — collection中正在处理的当前元素。
callbackfn.index — collection中正在处理的当前元素的索引。
callbackfn.array — 调用了collection forEach
。
thisArg - this
关键字可以在callbackfn
函数中引用的对象。 如果省略thisArg
,则使用undefined
作为this
值。
Optional
fromIndex : numbertrue
如果在数组中找到searchElement
;否则为false
。
searchElement - 要搜索的元素。
fromIndex - 此数组中开始搜索searchElement
的位置。 负值从 array.length + fromIndex 的索引按 asc 搜索。
fromIndex
is currently not supported. 因此,所有搜索都从索引 0 开始。
Optional
fromIndex : number在collection中可以找到给定元素的第一个索引,如果不存在,则为 -1。
searchElement - 要在collection中查找的元素。
fromIndex - 开始搜索的collection索引。如果省略,则从索引 0 开始搜索。
fromIndex
is currently not supported. 因此,所有搜索都从索引 0 开始。
Optional
fromIndex : number在collection中可以找到给定元素的最后一个索引,如果不存在,则为 -1。从fromIndex
开始向后搜索collection。
searchElement - 要在collection中查找的元素。
fromIndex - 开始搜索的collection索引。如果省略,则从最后一个索引开始搜索。
一个新数组,其中包含对collection中每个元素调用callbackfn
函数的结果。
callbackfn — 最多接受三个参数的函数。 map
方法为collection中的每个元素调用callbackfn
函数一次。
callbackfn.value — collection中正在处理的当前元素。
callbackfn.index — collection中正在处理的当前元素的索引。
callbackfn.array — 调用了collection map
。
thisArg - this
关键字可以在callbackfn
函数中引用的对象。 如果省略thisArg
,则使用undefined
作为this
值。
返回集合中值的最小值或集合中所有对象中给定属性的最小值;如果集合为空,则返回undefined
。
仅支持 int、float、double 和 date 属性。 此方法会完全忽略null
值,因此不会返回该值。
Optional
属性 : string对于collection的对象,要取最小值的属性。
最小值。
如果不存在具有该名称的属性或者属性不是数字/日期,则抛出 TypeAssertionError 。
减少所产生的值。
callbackfn — 最多接受四个参数的函数。 reduce
方法为collection中的每个元素调用callbackfn
函数一次。
callbackfn.previousValue - 上次调用callbackfn
函数或initialValue
(如果已提供)时返回的值。 (见下文。)
callbackfn.currentValue - collection中正在处理的当前元素。
callbackfn.currentIndex - 集合中正在处理的当前元素的索引。
callbackfn.array — 调用了collection reduce
。
初始值 - 如果指定了initialValue
,则用作开始累加的初始值。 首次调用callbackfn
函数时会将此值作为参数而不是元素值提供。
减少所产生的值。
callbackfn — 最多接受四个参数的函数。 reduce
方法为collection中的每个元素调用callbackfn
函数一次。
callbackfn.previousValue - 上次调用callbackfn
函数或initialValue
(如果已提供)时返回的值。 (见下文。)
callbackfn.currentValue - collection中正在处理的当前元素。
callbackfn.currentIndex - 集合中正在处理的当前元素的索引。
callbackfn.array — 调用了collection reduce
。
初始值 - 如果指定了initialValue
,则用作开始累加的初始值。 首次调用callbackfn
函数时会将此值作为参数而不是元素值提供。
减少所产生的值。
callbackfn — 最多接受四个参数的函数。 reduce
方法为collection中的每个元素调用callbackfn
函数一次。
callbackfn.previousValue - 上次调用callbackfn
函数或initialValue
(如果已提供)时返回的值。 (见下文。)
callbackfn.currentValue - collection中正在处理的当前元素。
callbackfn.currentIndex - 集合中正在处理的当前元素的索引。
callbackfn.array — 调用了collection reduce
。
初始值 - 如果指定了initialValue
,则用作开始累加的初始值。 首次调用callbackfn
函数时会将此值作为参数而不是元素值提供。
减少所产生的值。
callbackfn — 最多接受四个参数的函数。 reduceRight
方法为collection中的每个元素调用callbackfn
函数一次。
callbackfn.previousValue - 上次调用callbackfn
函数或initialValue
(如果已提供)时返回的值。 (见下文。)
callbackfn.currentValue - collection中正在处理的当前元素。
callbackfn.currentIndex - 集合中正在处理的当前元素的索引。
callbackfn.array — 调用了collection reduceRight
。
初始值 - 如果指定了initialValue
,则用作开始累加的初始值。 首次调用callbackfn
函数时会将此值作为参数而不是元素值提供。
减少所产生的值。
callbackfn — 最多接受四个参数的函数。 reduceRight
方法为collection中的每个元素调用callbackfn
函数一次。
callbackfn.previousValue - 上次调用callbackfn
函数或initialValue
(如果已提供)时返回的值。 (见下文。)
callbackfn.currentValue - collection中正在处理的当前元素。
callbackfn.currentIndex - 集合中正在处理的当前元素的索引。
callbackfn.array — 调用了collection reduceRight
。
初始值 - 如果指定了initialValue
,则用作开始累加的初始值。 首次调用callbackfn
函数时会将此值作为参数而不是元素值提供。
减少所产生的值。
callbackfn — 最多接受四个参数的函数。 reduceRight
方法为collection中的每个元素调用callbackfn
函数一次。
callbackfn.previousValue - 上次调用callbackfn
函数或initialValue
(如果已提供)时返回的值。 (见下文。)
callbackfn.currentValue - collection中正在处理的当前元素。
callbackfn.currentIndex - 集合中正在处理的当前元素的索引。
callbackfn.array — 调用了collection reduceRight
。
初始值 - 如果指定了initialValue
,则用作开始累加的初始值。 首次调用callbackfn
函数时会将此值作为参数而不是元素值提供。
从collection实例中删除侦听器callback
。
之前通过Collection.addListener方法添加为侦听器的回调函数。
如果callback
不是函数,则抛出 TypeAssertionError 。
Optional
thisArg : anytrue
如果回调为任何collection元素返回真值;否则为false
。
predicate - 用于测试每个元素的函数。
predicate.value — collection中正在处理的当前元素。
predicate.index - 集合中正在处理的当前元素的索引。
predicate.array — 调用了collectionevery
。
thisArg - this
关键字可以在谓词函数中引用的对象。 如果省略thisArg
,则将undefined
用作this
值。
返回表示此collection的排序视图的新结果。
Realm 对象的集合可以根据这些对象的一个或多个属性进行排序,或者根据这些对象链接到的对象的属性进行排序。 要按单个属性排序,只需将该属性的名称传递给sorted()
,后面可以可选地加上一个布尔值,指示是否应反向排序。 对于多个属性,必须传递一组排序描述符,其中列出要排序的属性。
其他类型的collection按值本身而不是属性的进行排序,因此不应提供属性名称或排序描述符。
Optional
reverse : boolean按降序而不是升序排序。 如果descriptor
是排序描述符数组,则可能无法应用。
根据传入的参数对结果进行排序。
如果指定的属性不存在,则出现错误。
返回表示此collection的排序视图的新结果。
Realm 对象的集合可以根据这些对象的一个或多个属性进行排序,或者根据这些对象链接到的对象的属性进行排序。 要按单个属性排序,只需将该属性的名称传递给sorted()
,后面可以可选地加上一个布尔值,指示是否应反向排序。 对于多个属性,必须传递一组排序描述符,其中列出要排序的属性。
其他类型的collection按值本身而不是属性的进行排序,因此不应提供属性名称或排序描述符。
对collection进行排序的属性名称。
根据传入的参数对结果进行排序。
如果指定的属性不存在,则出现错误。
返回表示此collection的排序视图的新结果。
Realm 对象的集合可以根据这些对象的一个或多个属性进行排序,或者根据这些对象链接到的对象的属性进行排序。 要按单个属性排序,只需将该属性的名称传递给sorted()
,后面可以可选地加上一个布尔值,指示是否应反向排序。 对于多个属性,必须传递一组排序描述符,其中列出要排序的属性。
其他类型的collection按值本身而不是属性的进行排序,因此不应提供属性名称或排序描述符。
对collection进行排序的属性名称。
Optional
reverse : boolean根据传入的参数对结果进行排序。
如果指定的属性不存在,则出现错误。
JSON 序列化的普通对象表示形式。 使用循环 JSON 序列化库(例如@ungap/ Structured-clone和flatted )对具有循环结构的 Realm 实体进行字符串化。
普通对象的数组。
批量更新集合中的对象。
属性的名称。
更新后的属性值。
如果不存在具有该名称的属性,则出现错误。
2.0.0
包含collection中所有值的迭代器。
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/values | Array.prototype.values()}
使用TypeDoc生成
此类的实例通常是对象() 返回的实时collection,当与底层查询匹配的新对象添加到 Realm 或从 Realm 中删除时,该collection将进行更新。但是,快照()} 返回的结果不会实时更新(因此永远不会调用通过 addListener() 添加的回调回调)。
看
https://www.mongodb.com/zh-cn/docs/realm/sdk/react-native/model-data/data-types/collections/