FsToolkit.ErrorHandling.IcedTasks 3.3.0-beta001

This is a prerelease version of FsToolkit.ErrorHandling.IcedTasks.
There is a newer version of this package available.
See the version list below for details.
dotnet add package FsToolkit.ErrorHandling.IcedTasks --version 3.3.0-beta001
NuGet\Install-Package FsToolkit.ErrorHandling.IcedTasks -Version 3.3.0-beta001
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="FsToolkit.ErrorHandling.IcedTasks" Version="3.3.0-beta001" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add FsToolkit.ErrorHandling.IcedTasks --version 3.3.0-beta001
#r "nuget: FsToolkit.ErrorHandling.IcedTasks, 3.3.0-beta001"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install FsToolkit.ErrorHandling.IcedTasks as a Cake Addin
#addin nuget:?package=FsToolkit.ErrorHandling.IcedTasks&version=3.3.0-beta001&prerelease

// Install FsToolkit.ErrorHandling.IcedTasks as a Cake Tool
#tool nuget:?package=FsToolkit.ErrorHandling.IcedTasks&version=3.3.0-beta001&prerelease

FsToolkit.ErrorHandling

FsToolkit.ErrorHandling is a utility library to work with the Result type in F#, and allows you to do clear, simple and powerful error handling.

The library provides utility functions like map, bind, apply, traverse, sequence as well as computation expressions and infix operators to work with Result<'a, 'b>, Result<'a option, 'b>, Async<Result<'a, 'b>>, Async<Result<'a option, 'b>>, and Result<'a, 'b list>.

It was inspired by Chessie and Cvdm.ErrorHandling (the latter has now been merged into FsToolkit.ErrorHandling).

FsToolkit.ErrorHandling targets .NET Standard 2.0 and .NET Framework 4.6.1 and supports Fable.

Documentation

The documentation is available here.

Further material

Builds

GitHub Actions
GitHub Actions
Build History

NuGet

Package name Release Prelease
FsToolkit.ErrorHandling NuGet NuGet
FsToolkit.ErrorHandling.TaskResult NuGet NuGet
FsToolkit.ErrorHandling.JobResult NuGet NuGet
FsToolkit.ErrorHandling.AsyncSeq NuGet NuGet
FsToolkit.ErrorHandling.IcedTasks NuGet NuGet

Developing locally

Requirements
Compiling
> build.cmd <optional buildtarget> // on windows
$ ./build.sh  <optional buildtarget>// on unix

A motivating example

This example of composing a login flow shows one example of how this library can aid in clear, simple, and powerful error handling, using just a computation expression and a few helper functions. (The library has many more helper functions and computation expressions as well as infix operators; see the documentation for details.)

// Given the following functions:
//   tryGetUser: string -> Async<User option>
//   isPwdValid: string -> User -> bool
//   authorize: User -> Async<Result<unit, AuthError>>
//   createAuthToken: User -> Result<AuthToken, TokenError>

type LoginError = InvalidUser | InvalidPwd | Unauthorized of AuthError | TokenErr of TokenError

let login (username: string) (password: string) : Async<Result<AuthToken, LoginError>> =
  asyncResult {
    // requireSome unwraps a Some value or gives the specified error if None
    let! user = username |> tryGetUser |> AsyncResult.requireSome InvalidUser

    // requireTrue gives the specified error if false
    do! user |> isPwdValid password |> Result.requireTrue InvalidPwd

    // Error value is wrapped/transformed (Unauthorized has signature AuthError -> LoginError)
    do! user |> authorize |> AsyncResult.mapError Unauthorized

    // Same as above, but synchronous, so we use the built-in mapError
    return! user |> createAuthToken |> Result.mapError TokenErr
  }

Sponsor(s)

<a href="https://www.ajira.tech"><img src="./Ajira-logo.png" alt="Ajira Technologies, India" width="200" /></a>

Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.15.1 132 1/15/2024
4.15.0 97 1/10/2024
4.14.0 112 1/2/2024
4.13.0 135 12/10/2023
4.13.0-beta002 86 12/10/2023
4.13.0-beta001 89 12/10/2023
4.12.0 124 11/27/2023
4.11.1 124 11/23/2023
4.11.0 104 11/11/2023
4.10.0 117 10/16/2023
4.9.0 151 7/10/2023
4.8.0 118 7/7/2023
4.7.0 116 6/21/2023
4.7.0-beta001 104 6/21/2023
4.6.0 152 4/20/2023
4.6.0-beta001 103 4/20/2023
4.5.0 205 3/27/2023
4.5.0-beta002 120 3/19/2023
4.5.0-beta001 109 3/6/2023
4.4.0 215 2/21/2023
4.3.0 283 1/20/2023
4.2.1 328 12/19/2022
4.2.0 315 12/17/2022
4.1.0 259 12/13/2022
4.1.0-beta001 114 12/13/2022
4.0.0 306 11/19/2022
4.0.0-beta001 136 11/19/2022
3.3.1 298 11/19/2022
3.3.1-beta004 120 11/19/2022
3.3.1-beta003 120 11/18/2022
3.3.1-beta002 120 11/18/2022
3.3.1-beta001 119 11/18/2022
3.3.0-beta001 139 11/9/2022
3.2.0 326 10/31/2022
3.2.0-beta001 123 10/31/2022
3.1.0 390 10/19/2022
3.0.1 348 10/18/2022
3.0.0 371 10/14/2022
3.0.0-beta008 132 10/14/2022
3.0.0-beta007 151 4/15/2022
3.0.0-beta006 137 4/5/2022
3.0.0-beta005 131 4/5/2022
3.0.0-beta004 132 4/5/2022

- [Updates for .NET 7](https://github.com/demystifyfp/FsToolkit.ErrorHandling/pull/193). Credits @TheAngryByrd