Update Dictionary#set signature to take two arguments: key and value

[kraenhansen]

Problem

Currently our Dictionary#add method takes an object, like this:

dict.set({ key: value });

I see a couple of issues with this approach:

• When the key is only known at runtime, end users need to either:
  i. Construct an object before calling the method: const values = {}; values[key] = value; dict.set(values);
  i. Or use the less known square-bracket syntax: dict.set({ [key]: value });
• It's unclear (from the documentation) if a user can set multiple key-value pairs this way.

It is however nice that a user can assign multiple key-value pairs in a single method call.

Solution

I suggest migrating towards a more Map-like API:

dict.set(key, value);

We should detect that the method is called with two arguments and provide this as an overload to the existing method.

How important is this improvement for you?

I'd like to see it, but have a workaround

[sync-by-unito]

➤ papafe commented:

Not sure if this should have documentation changes, I don't know how much in details we usually go in the docs

[sync-by-unito]

➤ kraenhansen commented:

I think it should, it's essentially a new overload to the method with its own doc comment.

This page might also need to update (for RN and React Native): https://www.mongodb.com/docs/realm/sdk/react-native/realm-database/schemas/dictionaries/