Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I am creating unit tests for the
utilmodule. In the process, I discovered a couple of descrepencies between the source code inutil.tsand TypeScript. Fixing these are technically breaking changes:isJSONObjectshould returnfalsefornull. This was easy to miss because 1) JavaScript returnsobjectfortypeof null, and 2) TypeScript does not check that the return value is consistent with the the type predicate. The new unit tests detects this.elsebranch intoYDataType. If there are no type errors, it will never returnundefined, so we can removeundefinedfrom the return type. While this function is not exposed by the library (index.ts), it might be a breaking change.anyfrom the argument type oftoPlainValue.notImplementedtonever; since it always throws an exception, it never returns.I plan to release these under the next major version, where we also bump the peer dependency on immer to v10 (#13).