docs: add jsdoc to make it clear that ArrayCollection.add() is idempotent #6292
Conversation
There was a problem hiding this comment.
I believe you will also need to add @inheritDoc on the Collection methods that override those.
Also I am not so sure about your comments there, I would rather describe the purpose of those methods, not their implementation details. e.g. its not about add method being idempotent, the Collection cannot hold duplicates, the fact that we do the contains check is just an implementation detail, it would work the same without it, since the items are stored in a Set internally.
| @@ -159,6 +159,9 @@ export class Collection<T extends object, O extends object = object> extends Arr | |||
| return super.toJSON() as unknown as EntityDTO<TT>[]; | |||
| } | |||
|
|
|||
| /** | |||
There was a problem hiding this comment.
This needs to be over the set method too. Ideally on all the collection methods that are overriding the arraycollection ones.
There was a problem hiding this comment.
set seems not to be overriden in Collection.
Sorry I take time to respond because I was confused, and I'm currently replacing typeorm by mikro-orm, and I want to make sure I understand mikro-orm before adding jsdoc
Just starting with MikroOrm.
I found some places where there is no jsdoc not documentation, e.g for those two methods, I had to check source code to know if I need to do
if (collection.contains())before adding an item or not.