Add Result and runCatching utilities#1
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a TypeScript implementation of Result type and runCatching utility function, inspired by Kotlin's error handling patterns. The implementation provides a robust way to handle success and failure states without throwing exceptions.
- Add
Result<T>class for encapsulating success/failure outcomes - Add
runCatching()function for safe execution with automatic error catching - Include comprehensive test coverage and API documentation
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/stdlib/common/Result.ts | Core Result class implementation with methods for handling success/failure states |
| src/stdlib/common/runCatching.ts | Utility function that wraps function execution in Result type |
| src/stdlib/common/Throwable.ts | Type definition for throwable values |
| src/stdlib/common/index.ts | Export statements for new Result utilities |
| src/stdlib/common/Result.spec.ts | Comprehensive test suite for Result class methods |
| src/stdlib/common/runCatching.spec.ts | Test coverage for runCatching function |
| docs/api/core/kotlin-stdlib/kotlin/-result.md | API documentation for Result class |
| docs/api/core/kotlin-stdlib/kotlin/run-catching.md | API documentation for runCatching function |
| docs/.vitepress/config.mts | Navigation configuration updates for new documentation |
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.
Features
Resultclass andrunCatching()function.