Interface Relationship

A relationship definition.

Export

Relationship

Hierarchy

  • Relationship

Properties

foreign_key? is_list? ref?

Properties

Optional foreign_key

foreign_key?: any

The name of the field in the foreign collection that the relationship points to.

Memberof

Relationship

Optional is_list

is_list?: any

If true: - the relationship may point to many foreign documents. - the local field must be defined as an array in the collection schema.

Memberof

Relationship

Optional ref

ref?: any

A reference string for the foreign collection.

Memberof

Relationship

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc