docs(): Add setRelations docs

doug-martin · Apr 13, 2021 · 928b958 · 928b958
1 parent 87b3dc6
commit 928b958
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/documentation/docs/concepts/services.md b/documentation/docs/concepts/services.md
@@ -185,6 +185,16 @@ Adds relations to a `DTO`
 #### Returns
 The DTO the relations were added to.
 
+### `setRelations`
+Sets relations on a `DTO`
+#### Arguments
+* `relationName: string` - The name of the relation
+* `id: string | number` - The id of the DTO to add the relations to
+* `relationIds: (string | number)[]` - The ids of the relations to set. If the relationIds is empty the all relations will be removed.
+* `opts?: ModifyRelationOptions<DTO, Relation>` - Additional options apply when adding relations
+#### Returns
+The DTO the relations were added to.
+
 ### `setRelation`
 Set a relation on a DTO
 #### Arguments