RFC: add deep-set-by

[kgryte]

Checklist

Please ensure the following tasks are completed before filing an issue.

• Read and understood the Code of Conduct.
• Searched for existing issues and pull requests.
• If this is a general question, searched the FAQ for an existing answer.
• If this is a feature request, the issue name begins with RFC: .

Description

Description of the issue (or feature request).

This RFC proposes to add @stdlib/utils/deep-set-by. Currently, when @stdlib/utils/deep-set is provided a function as a value, the deepSet implementation treats the value as a callback. This prevents being able to set a deeply nested value in a straightforward manner.

To overcome this limitation, this proposal suggests moving the callback implementation to a separate package (@stdlib/utils/deep-set-by) and changing @stdlib/utils/deep-set to drop support for a callback argument.

Related Issues

Does this issue (or feature request) have any related issues?

No.

Questions

Any questions for reviewers?

One question is whether the name deep-set-by is appropriate. The names matches the suffix for omit-by and pick-by; however, the implementation details differ for the proposed package compared to the existing convention. Notably, omit-by and pick-by deal with predicates. In this case, a provided function is a setter, rather than a predicate.

Other

Any other information relevant to this issue (or feature request)? This may include screenshots, references, stack traces, sample output, and/or implementation notes.

No.

[kgryte]

In fact, one could imagine a deep-set-by implementation which matches omit-by and pick-up semantics. Notably, the "path" argument could be a predicate function, while the "value" argument could be either a constant value or a callback.

In which case, the proposal would require a different package name; e.g., deep-set-with.

[ognjenjevremovic]

Hey @kgryte. Me again :).
How are you?

Mind if I take a closer look this one?

If I understood well from the description, the new @stdlib/utils/deep-set-by should resemble the current @stdlib/utils/deep-set and the latter should be adjusted in a way that if the function is provided as a value, instead of treating it as a callback the function value provided should be set as a method on the object (following a provided path); correct?

[kgryte]

@ognjenjevremovic Welcome back! Your interpretation is correct! To put another way,

• The current @stdlib/utils/deep-set should be renamed to @stdlib/utils/deep-set-by.
• The utility to be added @stdlib/utils/deep-set should treat a function the same as any other value, deeply setting the value according to a provided path.

If you want to take a look at making these changes, that would be great!

[ognjenjevremovic]

Thanks for the feedback @kgryte. Just wanted to double check before putting the effort and introducing any misconception, by the faulty interpretation of the request.

I would gladly sign myself for this one if you don't mind me doing so?

[kgryte]

Go for it! Thanks!