Digite o nome alternativo PropertySchema

Esquema de propriedade: {
    default?: desconhecido;
    indexado?: IndexedType;
    mapTo?: string;
    objectType?: PrimitivePropertyTypeName | UserTypeName;
    opcional?: booleano;
    apresentação?: Nome do tipo de propriedade da apresentação;
    propriedade?: string;
    type: PropertyTypeName;
}

O esquema para especificar o tipo de propriedade de um objeto específico do Realm.

Requisitos:

  • "mixed" tipos são sempre opcionais porque null é um valor válido dentro do próprio "mixed" . Portanto, eles não podem tornar-se não opcionais.
  • Os tipos de objeto definidos pelo usuário são sempre opcionais, exceto em listas e conjuntos, devido ao objeto ser excluído sempre que é removido das listas e conjuntos e, portanto, nunca são definidos como null ou undefined. Enquanto em dicionários, os valores excluídos são definidos como null e não podem ser tornados não opcionais.
  • As propriedades declaradas como chave primária em ObjectSchema.primaryKey são sempre indexadas. Nesses casos, eles não podem ficar não indexados.

Declaração de tipo

  • Optional default?: desconhecido

    O valor padrão para o qual a propriedade será definida quando criada.

  • Optional indexado?: IndexedType

    O tipo de índice aplicado à propriedade.

    Valor padrão: false se a propriedade não for uma chave primária, caso contrário, true.

  • Optional mapearpara?: string

    O nome a ser mantido no arquivo Realm se for diferente do nome da propriedade JavaScript/Typescript JavaScriptdefinido. Isso é útil para permitir convenções de nomenclatura diferentes do que é persistente no arquivo Realm. As propriedades de leitura e escrita devem ser feitas usando o nome JavaScript/Typescript, mas as queries podem usar o nome JavaScript/Typescript ou o nome persistente.

  • Optional Tipo de objeto?: PrimitivePropertyTypeName | UserTypeName

    O tipo dos elementos na coleção se type for um CollectionPropertyTypeName ou o tipo de objeto de Realm específico se type for um RelacionamentoPropertyTypeName.

  • Optional opcional?: booleano

    Se permitir que null ou undefined seja atribuído à propriedade; ou no caso de uma collection, a ser atribuída aos seus elementos. (Os tipos de objeto de realm em listas e conjuntos não podem ser opcionais.)

    Valor padrão: false exceto nos casos listados na documentação deste tipo.

  • Optional apresentação?: Nome do tipo de propriedade da apresentação

    O tipo de apresentação da propriedade.

    Alguns tipos podem ser apresentados como um tipo diferente do tipo de banco de dados de dados. Por exemplo, um número inteiro que deve se comportar como um contador lógico é apresentado como um tipo "counter" .

    Exemplo

    // A counter
    {
       type: "int",
       presentation: "counter",
    }
  • Optional propriedade?: string

    O nome da propriedade do objeto especificado no objectType que cria este link. (Só pode ser definido para vincular objetos.)

  • type: PropertyTypeName

    O tipo da propriedade.

Veja

  • PropertySchemaShorthand para uma representação abreviada de um esquema de propriedade .
  • PropertySchemaStrict para uma definição de tipo precisa dos requisitos com as combinações permitidas. O PropertySchema é menos rigoroso para fornecer uma opção mais amigável devido às mensagens de erro enganosas do Typescript ao trabalhar com o tipo rigoroso. Esse tipo é atualmente recomendado por esse motivo, mas o tipo rigoroso é fornecido como orientação. (Os erros exatos sempre serão mostrados ao criar uma instância do Realm se o esquema for inválido.)

Configurações

Visibilidade do membro

Tema

Gerado usando TypeDoc