Conversation
Found this issue when creating a wrapper function
There was a problem hiding this comment.
Pull request overview
This PR adjusts the library’s public TypeScript typings to behave more predictably when consumers create wrapper functions around mattr/parse, and aligns excerpt function typing with actual runtime behavior.
Changes:
- Allow custom excerpt functions (
ExcerptFunction) to returnnull. - Simplify
parseandextractExcerpttypings by removingZodType-specific overload signatures. - Add a patch changeset for the release.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
src/types.ts |
Updates ExcerptFunction return type to string | null to match runtime behavior. |
src/parse.ts |
Removes overload signatures and consolidates parse into a single generic signature. |
src/excerpt.ts |
Removes ZodType overload signatures for extractExcerpt and unused import. |
.changeset/soft-experts-boil.md |
Adds a patch release note for the typing fix. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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 noticed that when creating a wrapper function the types were acting up and only
ZodTypewas working well