strongloop / loopback-next / 15917

76%

push

travis-ci-com

feat(repository): make `targetsMany` property required

Modify `RelationDefinitionBase` to require all relation definitions
to provide value of `targetsMany` field.

BREAKING CHANGE: If you are building a custom relation type with its
own definition interface, make sure the interface includes `targetsMany`
property. Typically, the type of this property is hard-coded as `true`
or `false`, depending on the relation type.

```ts
interface HasManyDefinition extends RelationDefinitionBase {
  type: RelationType.hasMany;
  targetsMany: true;
  // etc.
}

export interface BelongsToDefinition extends RelationDefinitionBase {
  type: RelationType.belongsTo;
  targetsMany: false;
  // etc.
}
```

When creating an instance of a relation definition, make sure to include
a value for `targetsMany` property.

```ts
new ModelDefinition('Order')
  .addRelation({
    name: 'customer',
    type: RelationType.belongsTo,
    targetsMany: false,
    source: Order,
    target: () => Customer,
    keyFrom: 'customerId',
    keyTo: 'id',
  });
```

Signed-off-by: Miroslav Bajtoš <mbajtoss@gmail.com>

4336 of 5015 branches covered (86.46%)

Branch coverage included in aggregate %.

11222 of 11796 relevant lines covered (95.13%)

947.38 hits per line