Version: Annotations-V1.0.0

RelationOptions

Type alias: RelationOptions

Ƭ RelationOptions: Object

Interface of the options that are passed to the Relation Decorator

Example

class A extends FrostObject{
...
@Relation({
 name: "AB",
relation: RelationTypes.ONE_TO_MANY,
type: () => B,
})
b?:() => B[]

...
}

Name	Type	Description
`master?`	`boolean`	In Case of Asymmetric (One to Many) relation, to decide which side is the one and which side is the many.
`name`	`string`	the name of the relation, It should be the same on both sides
`reference?`	`string`	(unrecommended) the name of the local field that contains the id that the relations is based on. this is optional and actually it's recommend not to use unless needed. Frost by default handles the relations and the stored keys that connect the nodes, but if you need access to these keys you could use the methods (getConnectedKeys, FrostObject.getAllConnectedKeyss or you could set the reference on the relation.
`relation?`	`RelationTypes`	the relation type [One to One, One to Many, Many to Many]
`type`	`any`	the data type of the local property that the relation is defined on, (ignore array brackets in case of many-to-many/ one-to-many). this is needed because of some limitations in the decorators in TS/JS. also it needs to be a function that returns the type to avoid cyclic dependency `(()=>Type)` check the example