refactor: Simplify type params of KurtStream (and refactor surrounding to match) #8
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
…g to match) Prior to this commit, the type argument of KurtStream needed to be the inner schema (i.e. something that `extends KurtSchemaMaybe`) and from this we derived what the result data type would be. However, that was overly complicated, and nothing about the inner schema was actually being used within the class - only the derived result data type. So, to simplify things, KurtStream's type argument is now the actual result data type itself, rather than the schema. This makes it easier for callers who want to use the KurtStream or KurtStreamEvent or KurtResult data types, as each of these now can take an easier-to-obtain type argument. BREAKING CHANGE: Type argument of KurtStream has changed its meaning
andreszorro
approved these changes
May 6, 2024
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.
Prior to this commit, the type argument of KurtStream needed to be the inner schema (i.e. something that
extends KurtSchemaMaybe) and from this we derived what the result data type would be.However, that was overly complicated, and nothing about the inner schema was actually being used within the class - only the derived result data type.
So, to simplify things, KurtStream's type argument is now the actual result data type itself, rather than the schema. This makes it easier for callers who want to use the KurtStream or KurtStreamEvent or KurtResult data types, as each of these now can take an easier-to-obtain type argument.
BREAKING CHANGE: Type argument of KurtStream has changed its meaning