Add an original function #179
Conversation
__tests__/original.js
Outdated
| } | ||
|
|
||
| it("should return the original from the proxy", () => { | ||
| const nextState = produce(baseState, draftState => { |
There was a problem hiding this comment.
could you update the test to check both with useProxies(true) and useProxies(false)?
__tests__/original.js
Outdated
| }) | ||
| }) | ||
|
|
||
| it("should return the same object from an object that is not proxied", () => { |
There was a problem hiding this comment.
could you add a test that for a newline introduced object on the draft it returns undefined?
There was a problem hiding this comment.
And the same for a value that is a primitive
There was a problem hiding this comment.
Ok, so you mean:
produce(baseState, draftState => {
draftState.c = {};
draftState.d = 3;
expect(original(draftState.c)).toBeUndefined()
expect(original(draftState.d)).toBeUndefined()
})I wrote it such that it would just return the same object in that case as ultimately we just want the original object, and for those that think it may be being proxied when setting it it may be useful to not return a different type (i.e. undefined)? Happy to change this behaviour to undefined in the implementation though if you'd rather 👍
There was a problem hiding this comment.
I think returning undefined is slightly more intuitive / better supports fail-fast scenarios better. If you agree, I'll happily merge!
There was a problem hiding this comment.
I've made those changes! It makes the types a bit fiddlier: anyone using TS / Flow with this function will have to check for undefined each time now as for TS I don't think you can pattern match on DraftObject due to that fact that any object extends it. And the Flow types don't try and make that distinction anyway.
|
Looks great! I added some comments about introducing a few more test cases |
RichieAHB
force-pushed
the
rahb/add-original
branch
from
0189010 to
c16b5b0
Compare
|
Merged! Thanks a lot |
This addresses #153 and exposes an
originalfunction, useful for===comparing a proxy with an original object. The docs / tests should explain most of the implementation!