Return object from the .set() method

[kjellmorten]

Just a small change to return the object from the set method. I find it convenient in some cases, and it does not add any significant overhead.

Feel free to merge if this makes sense to you. Tests and readme are updated accordingly.

[sindresorhus]

I find it convenient in some cases

Do you have an example of that? I'm trying to think of when it would be useful.

[sindresorhus]

Better to write it in text. Something like:

Returns the object.

[kjellmorten]

Thanks! See new commit.

[kjellmorten]

@sindresorhus As an example, I have a function that takes a value, does something to it, and returns it at a path in a new object. (The path is provided at run-time, so regular JS object notation is not an option.)

When set does not return the object, I have to write:

const object = {}
set(object, path, value)
return object

With this PR I could simply write:

return set({}, path, value)

It's not a big issue – just for convenience. :)

[sindresorhus]

Makes sense. Can you use something like that in the readme example too? const foo = obj => dotProp.set(obj, 'unicorn', '🦄'); Makes it easier to understand the use-case of it.

[kjellmorten]

Sure. I had an example of the return value, but it wasn't clear enough. Changed the input to an empty object, so it is clearer what the point of it is.

Sorry I didn't return a unicorn.