访问类型为以下类型的对象属性时,返回此类的实例: "Dictionary"

字典的行为大多类似于 JavaScript 对象,即作为键/值对,其中键是字符串。

类型参数

  • T =未知

层次结构(查看完整

可转位

[ key: string ]: T

@ts-expect-error 我们在密钥的最终用户命名空间中公开方法

构造函数

方法

  • 返回Generator < [ string , T ] , any , unknown >

    包含字典中所有条目的迭代器。

  • 添加监听器callback ,当实时collection实例发生更改时将调用该监听器。

    参数

    • callback : DictionaryChangeCallback < T >

      发生更改时要调用的函数。

    • Optional keyPaths : string | string []

      指示与侦听器相关的更改的下限。 这是一个下限,因为如果添加了多个侦听器(每个侦听器都有自己的keyPaths ),这些键路径的并集将确定被视为与在collection上注册的所有侦听器相关的更改。换言之:如果存在具有不同键路径的其他侦听器,则侦听器触发的次数可能会超过键路径指定的次数。

    返回void

    注意

    deletionsoldModifications报告更改发生之前集合中的索引,而insertionsnewModifications报告新版本集合中的索引。

    抛出异常

    如果callback不是函数,则出现TypeAssertionError

    例子

    wines.addListener((collection, changes) => {
    // collection === wines
    console.log(`${changes.insertions.length} insertions`);
    console.log(`${changes.oldModifications.length} oldModifications`);
    console.log(`${changes.newModifications.length} newModifications`);
    console.log(`${changes.deletions.length} deletions`);
    console.log(`new size of collection: ${collection.length}`);
    });

    例子

    wines.addListener((collection, changes) => {
    console.log("A wine's brand might have changed");
    }, ["brand"]);

    注意

    添加侦听器是一项异步操作,因此首次调用回调以在添加侦听器时通知调用者。因此,首次调用回调时,它将包含changes对象中每个属性的空数组。

  • 返回Generator < [ string , T ] , any , unknown >

    包含字典中所有键/值对的迭代器。

    Array.prototype.entries

    since

    10.5.0 @ts-expect-error 我们在条目的最终用户命名空间中公开方法

  • 检查此字典是否未被删除以及是否是有效 Realm 的一部分。

    返回布尔值

    true 是否可以安全地访问字典。

    since

    0.14.0 @ts-expect-error 我们在密钥的最终用户命名空间中公开方法

  • 返回Generator < string , any , unknown >

    包含字典中所有值的迭代器。

    Array.prototype.keys

    since

    10.5.0 @ts-expect-error 我们在密钥的最终用户命名空间中公开方法

  • 使用提供的键从字典中删除元素。 如果字典中已经缺少键,则不会抛出异常。

    参数

    • key : string | string []

      要删除的键。

    返回

    字典

    抛出异常

    如果不在写事务(write transaction)中,则抛出断言错误

    since

    10.6.0 @ts-expect-error 我们在密钥的最终用户命名空间中公开方法

  • 从collection实例中删除所有callback侦听器。

    返回void

  • 将具有指定键和值的一个或多个元素添加到字典中,或者如果键存在则更新值。

    参数

    • elements : {
          [ key : string ] : T ;
      }

      要添加的元素的对象。

      • [key : string ]: T

    返回

    字典。

    抛出异常

    如果输入对象不在写事务(write transaction)内,则包含符号键或者任何值违反了类型约束,则为AssertionError

    since

    10.6.0 @ts-expect-error 我们在密钥的最终用户命名空间中公开方法

  • 将具有指定键和值的元素添加到字典中,或者如果键存在则更新。

    参数

    • key : string

      要添加的元素的键。

    • T

      要添加的元素的值。

    返回

    字典。

    抛出异常

    AssertionError如果不在写事务(write transaction)中,键是一个符号,或者如果值违反了类型约束。

    since

    12.0.0

  • JSON 序列化的普通对象表示形式。 使用循环 JSON 序列化库(例如@ungap/ Structured-cloneflatted )对具有循环结构的 Realm 实体进行字符串化。

    参数

    • Optional _ :字符串
    • Optional 缓存未知

    返回默认对象

    一个普通对象。 @ts-expect-error 我们在密钥的最终用户命名空间中公开方法

  • 返回Generator < T , any , unknown >

    包含字典中所有值的迭代器。

    Array.prototype.values

    since

    10.5.0 @ts-expect-error 我们在最终用户值命名空间中公开方法

使用TypeDoc生成