Eliminate NonEmptyObject
#2152
Eliminate NonEmptyObject
#2152
Conversation
This was introduced in mobxjs#1269 to prevent passing in any object to a model type that had no props. Although this works great, some people have found it harder to work with because now `keyof typeof MyModelType` now has this extra key they have to deal with. One could intersect that type with `string`, but it's unfortunate that users have to do this. Instead, we use `Record<string, never>` which can only be represented by an empty object literal. Snapshot preprocessors also had to be tweaked because they can emit properties that aren't known to them in the case of composition with other types.
There was a problem hiding this comment.
Hey @thegedge - this is awesome!
CI seems to be failing, but it passes locally for me (as you said it did for you, too). I tried re-running, but no luck.
I'm about to turn in for the night, but I can take a look tomorrow and see if I can figure out what's blocking CI.
Once that passes, I'll probably merge into master, and ship it as part of the pre-release build alongside #2151.
Thanks again, this is awesome!
Yeah, looks like it's typechecking locally, but not when I open the specific file. I think this is some misconfiguration of |
|
Looks like that last attempt failed too. I'll keep poking. It's possible that we ended up at this |
thegedge
force-pushed
the
remove-nonemptyobject
branch
from
df0bbb8 to
e79710e
Compare
|
Fixed. Added in some more checks and comments to hopefully help explain things. |
|
LGTM! Thanks again for all the hard work. |
* Eliminate `NonEmptyObject` This was introduced in #1269 to prevent passing in any object to a model type that had no props. Although this works great, some people have found it harder to work with because now `keyof typeof MyModelType` now has this extra key they have to deal with. One could intersect that type with `string`, but it's unfortunate that users have to do this. Instead, we use `Record<string, never>` which can only be represented by an empty object literal. Snapshot preprocessors also had to be tweaked because they can emit properties that aren't known to them in the case of composition with other types. * Don't allow symbols in input snapshots for models with no props
What does this PR do and why?
Resolves #1524
NonEmptyObjectwas introduced in #1269 to prevent passing in any object to a model type that had no props.Although this works great, some people have found it harder to work with because now
keyof typeof MyModelTypenow has this extra key they have to deal with. One could intersect that type withstring, but it's unfortunate that users have to do this.Instead, we use
Record<string, never>which can only be represented by an empty object literal. Snapshot preprocessors also had to be tweaked because they can emit properties that aren't known to them in the case of composition with other types.Steps to validate locally
New test added to prove this works, and ran the existing test suite to ensure no breakages.