Update serializer types to support enzyme-to-json #109
Conversation
This file contains 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
Current type declaration for serializer causes errors when used with `enzyme-to-json`. Changes: * `diffOptions` is now an optional parameter (as it is in code). * Type declaration for the second `serialize` parameter of the `print` function has been weakened to `any` due to incorrect type used in `enzyme-to-json` (should be function, but has been typed serializer) * Return type declaration from `print` function has been weakened to `any`; this function is not limited to only returning strings. Conflicting `enzyme-to-json` declaration: https://github.com/adriantoine/enzyme-to-json/blob/d1f86ee82ce014bb3d63f521a5d553307948eff0/index.d.ts#L22-L25 Mismatch of `enzyme-to-json` `serializer` type in `print` function: https://github.com/adriantoine/enzyme-to-json/blob/d1f86ee82ce014bb3d63f521a5d553307948eff0/src/createSerializer.js#L9-L11 Fixes jest-community#108
thymikee
reviewed
Jan 11, 2020
| @@ -25,8 +25,8 @@ declare namespace jest { | |||
|
|
|||
| interface Serializer { | |||
| test: (value: any) => boolean; | |||
| print: (value: any, _serializer?: Function) => string; | |||
| diffOptions: (valueA: any, valueB: any) => DiffOptions; | |||
| print: (value: any, _serializer?: any) => any; | |||
There was a problem hiding this comment.
I think we can leave the string return here
There was a problem hiding this comment.
@thymikee Unfortunately not; the enzyme-to-json type declaration for JestSerializer has print returning their Json type which is an object.
Keeping it as string give this error:
Type 'JestSerializer' is not assignable to type 'Serializer'.
Types of property 'print' are incompatible.
Type '(CommonWrapper: any, serializer: JestSerializer) => Json' is not assignable to type '(value: any, _serializer?: any) => string'.
Type 'Json' is not assignable to type 'string'.
There was a problem hiding this comment.
Oh, wasn't aware. That's fine then
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.
Current type declaration for serializer causes errors when used with
enzyme-to-json. Changes:diffOptionsis now an optional parameter (as it is in code).serializeparameter of theprintfunction has been weakened to
anydue to incorrect type used inenzyme-to-json(should be function, but has been typed serializer)printfunction has been weakened toany; this function is not limited to only returning strings.Conflicting
enzyme-to-jsondeclaration:https://github.com/adriantoine/enzyme-to-json/blob/d1f86ee82ce014bb3d63f521a5d553307948eff0/index.d.ts#L22-L25
Mismatch of
enzyme-to-jsonserializertype inprintfunction:https://github.com/adriantoine/enzyme-to-json/blob/d1f86ee82ce014bb3d63f521a5d553307948eff0/src/createSerializer.js#L9-L11
Fixes #108
/cc: @simonsmith @thymikee