成员
collection中值的数量。
类型:
number
null
是否为collection的有效值。
类型:
boolean
collection中值的类型。
类型:
string
方法
- 值
- 类型:
T
要添加到集合的值
-
TypeError
如果
value
不是可以存储在 Set 中的类型,或者添加到 Set 中的对象与 Set 的object schema
不匹配。
-
Error
如果不在写事务(write transaction)中。
-
Error
如果不在写事务(write transaction)中。
- 值
- 类型:
T
要从集合中删除的值
-
Error
如果不在写事务(write transaction)中。
- 值
- 类型:
T
要在集合中搜索的值
-
TypeError
如果
value
不是可以存储在 Set 中的类型,或者添加到 Set 中的对象与 Set 的object schema
不匹配。
Realm.Set
向集合添加值
参数:
抛出异常:
Realm.Set
:添加元素后的 Set 本身
void
从集合中删除所有值
抛出异常:
void
boolean
从集中删除值
参数:
抛出异常:
boolean
:如果该值存在于集中,则为 true,否则为 false
boolean
检查集合中是否存在值
参数:
抛出异常:
boolean
:如果该值存在于集中,则为 True,否则为 False
继承方法
- callback
- 类型:
function
发生更改时要调用的函数。 使用两个参数调用回调函数:
collection
:发生更改的集合实例,changes
:具有键insertions
、newModifications
、oldModifications
和deletions
的字典,每个键都包含集合中分别插入、更新或删除的索引列表。deletions
和oldModifications
是更改发生之前集合的索引,而insertions
和newModifications
是新版本集合的索引。
-
Error
如果
callback
不是函数。
- 属性 可选
- 类型:
string
对于对象集合,要计算平均值的属性。
-
Error
如果不存在具有该名称的属性或者属性不是数字。
- callback
- 类型:
function
对集合中每个对象执行的函数。 如果此函数为每个对象返回
true
,则此方法将返回true
。 该函数接受三个参数:object
– collection中正在处理的当前对象。index
– collection中正在处理的对象的索引。collection
– collection本身。
- thisArg 可选
- 类型:
object
调用
callback
时this
的值。- 查询
- 类型:
string
用于从collection中筛选对象的查询。
- arg 可选 可重复
- 类型:
any
每个后续参数都由占位符使用(例如
$0
、$1
、$2
、...)在查询中。-
Error
如果传递给该方法的查询或任何其他参数无效。
- callback
- 类型:
function
对集合中每个对象执行的函数。 如果此函数返回
true
,则此方法将返回该对象。 该函数接受三个参数:object
– collection中正在处理的当前对象。index
– collection中正在处理的对象的索引。collection
– collection本身。
- thisArg 可选
- 类型:
object
调用
callback
时this
的值。- callback
- 类型:
function
对集合中每个对象执行的函数。 如果此函数返回
true
,则此方法将返回该对象的索引。 该函数接受三个参数:object
– collection中正在处理的当前对象。index
– collection中正在处理的对象的索引。collection
– collection本身。
- thisArg 可选
- 类型:
object
调用
callback
时this
的值。- callback
- 类型:
function
对集合中每个对象执行的函数。 该函数接受三个参数:
object
– collection中正在处理的当前对象。index
– collection中正在处理的对象的索引。collection
– collection本身。
- thisArg 可选
- 类型:
object
调用
callback
时this
的值。- 对象
- 类型:
T
要在collection中搜索的值。
-
Error
如果参数是与collection不属于同一 Realm 的
Realm.Object
。
- 分隔符 可选
- 类型:
string
- 默认:
","
一个字符串,用于分隔对collection中每个对象调用的
toString()
方法的返回值。- callback
- 类型:
function
对集合中每个对象执行的函数。 该函数接受三个参数:
object
– collection中正在处理的当前对象。index
– collection中正在处理的对象的索引。collection
– collection本身。
- thisArg 可选
- 类型:
object
调用
callback
时this
的值。- 属性 可选
- 类型:
string
对于collection的对象,要取最大值的属性。
-
Error
如果不存在具有以下名称的属性,或者属性不是数字/日期。
- 属性 可选
- 类型:
string
对于collection的对象,要取最小值的属性。
-
Error
如果不存在具有以下名称的属性,或者属性不是数字/日期。
- callback
- 类型:
function
对集合中每个对象执行的函数。 该函数有四个参数:
previousValue
– 上次调用回调时返回的值,或initialValue
(如果已提供)。object
– collection中正在处理的当前对象。index
– collection中正在处理的对象的索引。collection
– collection本身。
- 初始值 可选
- 类型:
object
用作首次调用
callback
的第一个参数的值。-
TypeError
如果collection为空且未提供
initialValue
。
- 如果collection由单个对象组成,并且未提供
initalValue
,则将返回该对象。 - 如果集合为空,则必须提供
initialValue
,该集合将返回。 - callback
- 类型:
function
对collection中从右到左的每个对象执行的函数。该函数有四个参数:
previousValue
– 上次调用回调时返回的值,或initialValue
(如果已提供)。object
– collection中正在处理的当前对象。index
– collection中正在处理的对象的索引。collection
– collection本身。
- 初始值 可选
- 类型:
object
用作首次调用
callback
的第一个参数的值。-
TypeError
如果collection为空且未提供
initialValue
。
- 如果collection由单个对象组成,并且未提供
initalValue
,则将返回该对象。 - 如果集合为空,则必须提供
initialValue
,该集合将返回。 - callback
- 类型:
function
之前通过
addListener
方法添加为侦听器的回调函数。-
Error
如果
callback
不是函数。
- 开始 可选
- 类型:
number
- 默认:
0
起始索引。 如果为负数,则起始索引将从collection的末尾开始计数。
- end 可选
- 类型:
number
结束索引。 直到(但不包括)结束索引的对象将包含在返回值中。 如果为负数,则结束索引将从集合末尾开始计数。 如果省略,则起始索引中的所有对象都将包含在返回值中。
-
Error
对基元类型的collection进行快照时。
- callback
- 类型:
function
对集合中每个对象执行的函数。 如果此函数返回
true
,则此方法将返回true
。 该函数接受三个参数:object
– collection中正在处理的当前对象。index
– collection中正在处理的对象的索引。collection
– collection本身。
- thisArg 可选
- 类型:
object
调用
callback
时this
的值。- 描述符 可选
- 类型:
string
或[SortDescriptor, ...]
对collection进行排序的属性名称。
- reverse 可选
- 类型:
boolean
- 默认:
false
按降序而不是升序排序。 如果
descriptor
是排序描述符数组,则可以不提供。-
Error
如果指定的属性不存在。
- 属性 可选
- 类型:
string
对于collection的对象,要求和的属性。
-
Error
如果不存在具有该名称的属性或者属性不是数字。
Iterator<T>
添加监听器callback
,当实时collection实例发生更改时将调用该监听器。
参数:
抛出异常:
示例:
wines.addListener((collection, changes) => {
// collection === wines
console.log(`${changes.insertions.length} insertions`);
console.log(`${changes.modifications.length} modifications`);
console.log(`${changes.deletions.length} deletions`);
console.log(`new size of collection: ${collection.length}`);
});
number
计算集合中值的平均值或集合中所有对象中给定属性的平均值,如果集合为空,则为undefined
。
仅支持 int、float 和 double 属性。 此方法会完全忽略null
值,也不会计入平均值。
参数:
抛出异常:
number
总和。
boolean
参数:
boolean
表示callback
是否为集合中的每个对象返回true
。
Realm.Results<T>
返回表示此collection按所提供的查询进行筛选的新结果。
参数:
抛出异常:
Realm.Results<T>
根据提供的查询进行筛选。目前仅 Realm 对象集合支持此功能。有关查询语言的详细信息,请参阅查询语言。
示例:
let merlots = wines.filtered('variety == "Merlot" && vintage
T
or undefined
参数:
T
或undefined
如果callback
未为集合中的任何对象返回true
。
number
参数:
number
表示callback
返回true
的索引;如果从未返回true
,则返回-1
。
参数:
number
查找collection中给定对象的索引。
参数:
抛出异常:
number
表示找到该值的索引,如果不在collection中,则返回-1
。
boolean
检查此collection是否为空。
返回:boolean
指示collection是否为空。
boolean
检查此集合是否未被删除以及是否是有效 Realm 的一部分。
返回:boolean
指示是否可以安全地访问该集合。
string
将collection中的所有对象连接成一个字符串。
参数:
string
Iterator<T>
Iterator<T>
[any, ...]
参数:
[any, ...]
— 对collection中的每个对象调用callback
后的返回值。
number
返回集合中所有对象中值或给定属性的最大值;如果集合为空,则返回undefined
。
仅支持 int、float、double 和 date 属性。 此方法会完全忽略null
值,因此不会返回该值。
参数:
抛出异常:
number
最大值。
number
返回集合中值的最小值或集合中所有对象中给定属性的最小值;如果集合为空,则返回undefined
。
仅支持 int、float、double 和 date 属性。 此方法会完全忽略null
值,因此不会返回该值。
参数:
抛出异常:
number
最小值。
any
参数:
抛出异常:
any
– 最终调用callback
的返回值,以下特殊情况除外:
any
参数:
抛出异常:
any
– 最终调用callback
的返回值,以下特殊情况除外:
从collection实例中删除所有callback
侦听器。
从collection实例中删除侦听器callback
。
参数:
抛出异常:
[T, ...]
参数:
[T, ...]
。
Realm.Results<T>
创建集合的快照。
在原始collection中添加和删除的值不会反映在该方法返回的结果中,包括更改properties值以使其匹配或不匹配应用的任何筛选器的情况。
这不是深度快照。此快照中包含的 Realm 对象将随着对其进行的更改而继续更新,如果它们从 Realm 中删除,则它们将在相应索引处被null
替换。
抛出异常:
Realm.Results<T>
,这不会进行实时更新。
boolean
参数:
callback
为集合中的对象返回true
时,返回boolean
– true
,否则返回false
。
Realm.Results<T>
返回表示此collection的排序视图的新结果。
Realm 对象的集合可以根据这些对象的一个或多个属性进行排序,或者根据这些对象链接到的对象的属性进行排序。 要按单个属性排序,只需将该属性的名称传递给sorted()
,后面可以可选地加上一个布尔值,指示是否应反向排序。 对于多个属性,必须传递一组排序描述符,其中列出要排序的属性。
其他类型的collection按值本身而不是属性的进行排序,因此不应提供属性名称或排序描述符。
参数:
抛出异常:
Realm.Results<T>
。
示例:
// Sort wines by age
wines.sorted('age')
// Sort wines by price in descending order, then sort ties by age in
// ascending order
wines.sorted([['price', false], ['age']])
// Sort a list of numbers in ascending order
let sortedPrices = wine.pricesSeen.sort()
// Sort people by how expensive their favorite wine is
people.sort("favoriteWine.price")
number
计算集合中值的总和或集合中所有对象中给定属性的总和,如果集合为空,则计算 0。
仅支持 int、float 和 double 属性。 此方法完全忽略null
值。
参数:
抛出异常:
number
总和。