类型别名 PropertySchema

属性模式: {
    访问?: 未知
    已索引?: IndexedType
    mapTo?: 字符串
    objectType?: PrimitivePropertyTypeName | UserTypeName
    可选?: 布尔
    属性?: 字符串
    类型: PropertyTypeName
}

用于指定特定 Realm 对象属性类型的模式。

要求:

  • "mixed" 类型始终是可选的,因为null"mixed"本身内的有效值。 因此,不能将它们设置为非可选。
  • 用户定义的对象类型始终为可选,列表和集合除外,因为每当从列表和集合中删除对象时,该对象也会被删除,因此永远不会设置为nullundefined 。 而在字典中,已删除的值设置为null ,并且不能设为非可选。
  • ObjectSchema.primaryKey中声明为主键的属性始终会被索引。 在这种情况下,不能将它们设为非索引。

类型声明

  • Optional 访问?: 未知

    该属性在创建时设立的默认值。

  • Optional 已索引?: IndexedType

    应用于属性的索引类型。

    默认值:如果属性不是主键,则为false ,否则为true

  • Optional 映射到?: 字符串

    Realm如果与已定义的JavaScript /Typescript (JavaScript /Typescript ) 属性名称不同,则此名称将保留在 文件中。这对于允许使用与 Realm 文件中保留的命名约定不同的命名约定非常有用。 读取和写入属性必须使用JavaScript / Typescript名称来完成,但查询可以使用JavaScript / Typescript名称或持久名称。

  • Optional 对象类型?: PrimitivePropertyTypeName | UserTypeName

    如果typeCollectionPropertyTypeName ,则为集合中元素的类型;如果typeRelationshipPropertyTypeName ,则为特定 Realm 对象类型。

  • Optional 可选?: 布尔

    是否允许将nullundefined分配给该属性;如果是集合,则分配给其元素。 (列表和集中的 Realm 对象类型不能是可选的。)

    默认值: false ,此类型的文档中列出的情况除外。

  • Optional 属性?: 字符串

    objectType中指定的创建此链接的对象的属性名称。 (只能为链接对象而设置。)

  • 类型: PropertyTypeName

    属性的类型。

  • PropertySchemaShorthand用于属性模式的速记表示形式。
  • PropertySchemaStrict用于对需求进行精确的类型定义以及允许的组合。 此类型不那么严格,是为了提供更加用户友好的选项,因为在使用严格类型时, Typescript错误消息具有误导性。 出于这个原因,目前建议使用此类型,但提供严格类型仅供参考。 (如果模式无效,则创建Realm实例时将始终显示确切的错误。)

使用TypeDoc生成