Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FieldDescription

Hierarchy

  • FieldDescription

Index

Properties

Properties

Optional name

name: string

The name of the database document field.

Optional nullable

nullable: boolean

Indicates if null values are supported. If false then null values are not written to the database. Default is false.

Optional readable

readable: boolean

Indicates if the database document field should be read. Default is true. If set the false the database document field may still be written to but the field value is not read when deserializing the document from the database. This is useful if your entity has an accessor with a value calculated from other fields in the class that you want to store to the database for queries.

Generated using TypeDoc