feat(result): add unwrap and expect functions#37
Merged
Conversation
Inspired by Rust's Result, unwrap returns the success data or re-throws the failure's underlying error, while expect does the same but throws an error with a caller-provided message (preserving the original via cause).
🦋 Changeset detectedLatest commit: e021f2e The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
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.
Summary
Adds Rust-inspired
unwrapandexpectescape hatches to@byteslice/result, for the cases where a caller knows an operation should have succeeded and just wants the underlyingdata.unwrap(result)— returns the successdata, or re-throws the failure's underlyingError.expect(result, message)— returns the successdata, or throws a newError(message, { cause }), preserving the original error's stack trace viacause(consistent with how the existing docs treat errors).Both handle both
FailureOptionshapes (a bareErrorand the{ error: Error }custom-failure object).Design note
Resultis modelled as a plain discriminated union (not a class), and the public API is free functions likewithResult. To stay consistent, these are free functions (unwrap(result)) rather than methods (result.unwrap()) — keepingResulta plain, serializable object. If you'd prefer method-style chaining, that's a larger design shift worth discussing separately.A small internal
isSuccesstype guard is used because, with a generic failure typeF, TypeScript won't narrow the union onresult.failure === undefineddirectly.Testing
expect's message, andcausepreservation.bun test(13 pass),biome ci,cspell, andtsupbuild all pass.Changeset
Included a
minorchangeset (new backward-compatible features).