types: only apply BufferToBinary if type strictly equals Buffer | null | undefined #15072
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
…l | undefined Fix #15057
hasezoey
reviewed
Dec 5, 2024
There was a problem hiding this comment.
This PR causes typegoose (in its current state) fail to build (types):
src/typeguards.ts:21:12 - error TS2677: A type predicate's type must be assignable to its parameter's type.
Type 'Array<DocumentType<NonNullable<T>>>' is not assignable to type 'Array<Ref<T, S>>'.
Type 'DocumentType<NonNullable<T>>' is not assignable to type 'Ref<T, S>'.
Type 'DocumentType<NonNullable<T>>' is not assignable to type 'DocumentType<T, BeAnObject>'.
Type 'DocumentType<NonNullable<T>>' is not assignable to type 'Document<unknown, BeAnObject, T>'.
21 ): docs is mongoose.Types.Array<DocumentType<NonNullable<T>>>;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src/typeguards.ts:27:102 - error TS2677: A type predicate's type must be assignable to its parameter's type.
Type 'DocumentType<NonNullable<T>>[]' is not assignable to type 'Ref<T, S>[]'.
Type 'DocumentType<NonNullable<T>>' is not assignable to type 'Ref<T, S>'.
Type 'DocumentType<NonNullable<T>>' is not assignable to type 'DocumentType<T, BeAnObject>'.
Type 'DocumentType<NonNullable<T>>' is not assignable to type 'Document<unknown, BeAnObject, T>'.
27 export function isDocumentArray<T, S extends RefType>(docs: Ref<T, S>[] | null | undefined): docs is DocumentType<NonNullable<T>>[];
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Found 2 errors in the same file, starting at: src/typeguards.ts:21removing the NonNull<> from those 2 is locations seemingly fixes it, though it is quite weird to not be able to assert that T is not null or undefined anymore. (though it would be in-line with the isDocument definition from typegoose)
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.
Fix #15057
Summary
The issue in #15057 is that BufferToBinary adds
Binaryto any type thatextends undefinedorextends null, which is not intentional. This PR now only applies the BufferToBinary transform if the type strictly equals Buffer | null | undefined. I also made a similar change to other transforms we use for calculating the JSON serialized type.Examples