supermacro/neverthrow
Neverthrow
neverthrow is a TypeScript result type library that implements railway oriented programming. It provides a functional error handling framework using type-safe wrappers to represent operation outcomes as either success or failure variants, eliminating the need to throw exceptions.
The library features adapters that convert throwing functions and asynchronous promises into typed result objects. This allows asynchronous rejections and unsafe code to be handled as explicit return values rather than uncaught exceptions.
The framework covers a broad range of functional computation capabilities, including monadic chaining for sequential operations, error aggregation for collecting multiple failures, and result matching to ensure exhaustive error handling. It also provides mechanisms for error recovery, value transformation, and the execution of side effects on both success and failure tracks.
Additional support is provided for generator functions to implicitly handle errors and unwrap success values within a block.
Features
- Result - Implements a type-safe result wrapper based on sum types to represent operation outcomes as success or failure variants.
- Monadic Error Handling - Implements a comprehensive framework for monadic error handling using Result types to manage flow without exceptions.
- TypeScript Utility Libraries - Provides a type-safe result utility library for TypeScript to represent operation outcomes as success or failure variants.
- Promise-to-Result Converters - Transforms promises into result types by mapping rejections into specific, type-safe errors.
- Async Result Wrappers - Provides wrappers that convert promises into result types to handle asynchronous rejections as typed values.
- Promise-to-Result Wrappers - Transforms asynchronous promises into typed result objects with integrated mapping and chaining capabilities.
- Result Sequence Processing - Allows executing a sequence of dependent operations that halt immediately upon the first encountered error.
- Throwable Function Adapters - Converts functions that throw exceptions into result-returning functions by mapping unknown errors to known types.
- Exception-to-Result Adapters - Provides a utility to wrap throwing functions, ensuring all potential failures are handled via return types.
- Result Transformations - Provides monadic chaining to transform success values while automatically propagating errors.
- Asynchronous Result Wrappers - Wraps promises in a specialized class to provide mapping and chaining without requiring immediate awaiting.
- Throwable Function Adapters - Result converts potentially throwing functions into a consistent result type to ensure all errors are handled explicitly.
- Success and Failure Wrapping - Wraps return values in specific types to distinguish between successful outcomes and expected errors without throwing.
- Promise-To-Result Adaptation - Includes adapters that convert asynchronous promises into typed result objects to handle rejections as explicit values.
- Operation Chaining - Provides monadic chaining mechanisms to sequentially transform values through a series of functions.
- Railway Oriented Programming - Implements a pipeline pattern where operations either continue on a success track or diverge to an error track.
- Variant-Based Outcome Encoding - Encodes the result of an action as either a success or failure variant to avoid throwing exceptions.
- Exhaustive Result Handling - Executes one of two functions based on whether the outcome is a success or failure to ensure both cases are handled.
- Generator-Based Error Propagation - Utilizes generator functions and yield expressions to implicitly handle errors and unwrap success values.
- Generator-Based Unwrapping - Supports generator functions to implicitly handle errors and unwrap success values within a block.
- Generator Block Aborting - Uses generator functions to yield values and automatically abort the block if any operation returns a failure.
- Validation Error Aggregators - Allows collecting multiple independent failures into a single structured collection instead of stopping at the first error.
- Cumulative Error Collection - Implements error aggregation logic to collect multiple independent failures into a single list.
- Error Recovery - Handles failure cases and optionally transforms the resulting type to resume normal execution.
- Exhaustive Matching - Provides result matching to ensure exhaustive error handling by requiring specific functions for both success and failure cases.
- Result Value Extraction - Provides methods to retrieve a success value or return a specified default if the operation failed.
- Railway Side Effects - Provides mechanisms for executing side effects on both success and failure tracks without altering the result value.
- Result-Track Side Effects - Provides utilities to execute arbitrary logic on either the success or failure track without changing the result's state.
- Task Result Aggregation - Merges a list of outcomes into one result by either stopping at the first failure or gathering all errors.
- Result-Track Side Effects - Enables performing actions like logging specifically when an operation fails without altering the error object.
- Algebraic Data Types - Result type for representing success or failure.
