型エイリアス PropertySchema

プロパティ スキーマ: {
    default?: 不明;
    インデックス作成?: IndexedType;
    mapTo?: string;
    objectType?: PrimitivePropertyTypeName | UserTypeName;
    任意?: ブール値;
    プロパティ?: string;
    タイプ: PropertyTypeName;
}

特定の Realm オブジェクト プロパティのタイプを指定するためのスキーマ。

要件:

  • "mixed" nullは"mixed"内で有効な値であるため、 型は常に任意です。 したがって、これらを任意以外にすることはできません。
  • ユーザー定義のオブジェクトタイプは常に任意です。リストとセットから削除されるたびにオブジェクトは削除されるため、 nullまたはundefinedには設定されません。 一方、辞書では、削除された値はnullに設定され、任意以外の値にすることはできません。
  • ObjectSchema.primaryKeyでプライマリキーとして宣言されたプロパティは、常にインデックス付けされます。 このような場合、インデックスを非表示にすることはできません。

型宣言

  • Optional default?: 不明

    作成時にプロパティが設定されるデフォルト値。

  • Optional インデックス作成?: IndexedType

    プロパティに適用されるインデックスのタイプ。

    デフォルト値: プロパティがプライマリキーでない場合はfalse 、そうでない場合はtrue 。

  • Optional mapTo?: string

    Realmすでに定義されてJavaScript /Typescript （JavaScript /Typescript ）のプロパティ名と異なる場合に ファイルに保持する名前。これは、Realm ファイルに保存されているものとは異なる命名規則を許可するのに役立ちます。 読み取りおよび書込みプロパティはJavaScript / Typescript名を使用して実行する必要がありますが、クエリではJavaScript / Typescript名または永続的な名前のいずれかを使用できます。

  • Optional オブジェクトタイプ?: PrimitivePropertyTypeName | UserTypeName

    typeがCollectionPropertyTypeNameである場合のコレクション内の要素の型、またはtypeが ConnectionPropertyTypeName である場合は特定のRealmオブジェクトタイプ。

  • Optional 任意?: ブール値

    プロパティにnullまたはundefinedを割り当てることを許可するかどうか。または、コレクションの場合は、その要素に割り当てられます。 （リストとセット内の Realm オブジェクトタイプは任意ではありません。）

    デフォルト値: falseただし、このタイプのドキュメントにリストされている場合を除きます。

  • Optional プロパティ?: string

    このリンクを作成するobjectTypeで指定されたオブジェクトのプロパティの名前。 （オブジェクトをリンクする目的でのみ設定できます。）

  • タイプ: PropertyTypeName

    プロパティの型。

詳細は、次を参照してください:

  • プロパティ スキーマの短縮表現用のPropertySchemaResult
  • PropertySchemaStrictを使用して、許可された組み合わせで要件を正確に型定義する。 このタイプは、厳密なタイプを操作するときにTypescriptエラー メッセージが誤解されるため、よりユーザーに適したオプションを提供するために厳密性が低いです。 このタイプは現在、その理由により推奨されていますが、ガイダンスとしては厳密なタイプが提供されています。 （スキーマが無効な場合は、 Realmインスタンスの作成時に常に正確なエラーが表示されます）。

設定

テーマ

TypeDocを使用して生成