FsToolkit.ErrorHandling.TaskResult 4.12.0

.NET Standard 2.0
dotnet add package FsToolkit.ErrorHandling.TaskResult --version 4.12.0
NuGet\Install-Package FsToolkit.ErrorHandling.TaskResult -Version 4.12.0
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.TaskResult" Version="4.12.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add FsToolkit.ErrorHandling.TaskResult --version 4.12.0
#r "nuget: FsToolkit.ErrorHandling.TaskResult, 4.12.0"
#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.TaskResult as a Cake Addin
#addin nuget:?package=FsToolkit.ErrorHandling.TaskResult&version=4.12.0

// Install FsToolkit.ErrorHandling.TaskResult as a Cake Tool
#tool nuget:?package=FsToolkit.ErrorHandling.TaskResult&version=4.12.0

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

Devcontainer

This repository has a devcontainer setup for VSCode. For more infomation see:

Local Setup

Optional

To test fable builds locally you will need:

  • Node
    • v18.0.0 or Higher
    • Not required but recommend that you use NVM to easily manage multiple versions of Node
  • Python
    • v3.10.0 or higher
    • Required for Fable-Python
Compiling
> build.cmd <optional buildtarget> // on windows
$ ./build.sh  <optional buildtarget>// on unix

Without specifying a build target, the default target is DotnetPack, which will run tests for all projects on dotnet and then pack the projects into nuget packages. For additional notable targets see below.

Build Targets
  • Clean - Will clean all projects bin and obj folders
  • DotnetTest - Will run tests for dotnet projects
  • NpmTest - Will run tests for fable-javascript projects
  • PythonTest - Will run tests for fable-python projects
  • RunTests - Will run tests for dotnet, fable-javascript and fable-python projects
  • FormatCode - Will run fantomas to format the codebase

This is not an exhausting list. Additional targets can be found in the ./build/build.fs file.

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 net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  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-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (5)

Showing the top 5 NuGet packages that depend on FsToolkit.ErrorHandling.TaskResult:

Package Downloads
NBomber

Modern and flexible load testing framework for Pull and Push scenarios, designed to test any system regardless a protocol (HTTP/WebSockets/AMQP etc) or a semantic model (Pull/Push).

FsToolkit.ErrorHandling.JobResult

FsToolkit.ErrorHandling is an extensive utility library based around the F# Result type, enabling consistent and powerful error handling.

FsToolkit.ErrorHandling.IcedTasks

FsToolkit.ErrorHandling is an extensive utility library based around the F# Result type, enabling consistent and powerful error handling.

p1eXu5.FSharp.Ports.PortTaskResult

PortTaskResult computation expression.

Migrondi.Core

This is the core library for the Migrondi CLI, you can use this library to run the same functionality of Migrondi as part of your source code or to write an abstraction for different kind of tools.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.12.0 211 11/27/2023
4.11.1 314 11/23/2023
4.11.0 1,530 11/11/2023
4.10.0 3,641 10/16/2023
4.9.0 54,263 7/10/2023
4.8.0 1,163 7/7/2023
4.7.0 5,009 6/21/2023
4.7.0-beta001 428 6/21/2023
4.6.0 19,611 4/20/2023
4.6.0-beta001 418 4/20/2023
4.5.0 5,450 3/27/2023
4.5.0-beta002 466 3/19/2023
4.5.0-beta001 1,296 3/6/2023
4.4.0 40,325 2/21/2023
4.3.0 13,334 1/20/2023
4.2.1 9,073 12/19/2022
4.2.0 971 12/17/2022
4.1.0 2,178 12/13/2022
4.1.0-beta001 446 12/13/2022
4.0.0 13,793 11/19/2022
4.0.0-beta001 446 11/19/2022
3.3.1 27,249 11/19/2022
3.3.1-beta004 405 11/19/2022
3.3.1-beta003 445 11/18/2022
3.3.1-beta002 446 11/18/2022
3.3.1-beta001 427 11/18/2022
3.3.0-beta001 470 11/9/2022
3.2.0 79,192 10/31/2022
3.2.0-beta001 454 10/31/2022
3.1.0 14,864 10/19/2022
3.0.1 1,651 10/18/2022
3.0.0 3,892 10/14/2022
3.0.0-beta008 476 10/14/2022
3.0.0-beta007 19,204 4/15/2022
3.0.0-beta006 506 4/5/2022
3.0.0-beta005 478 4/5/2022
3.0.0-beta004 482 4/5/2022
3.0.0-beta003 509 3/30/2022
3.0.0-beta002 476 2/21/2022
3.0.0-beta001 458 2/21/2022
2.13.0 607,519 1/11/2022
2.13.0-beta001 466 1/11/2022
2.12.0 1,528 1/6/2022
2.12.0-beta001 450 1/6/2022
2.11.1 15,317 12/1/2021
2.11.1-beta001 1,056 12/1/2021
2.11.0 4,390 11/24/2021
2.11.0-beta004 3,407 11/24/2021
2.11.0-beta002 3,353 11/24/2021
2.11.0-beta001 3,217 11/24/2021
2.10.0 13,224 11/13/2021
2.9.0 1,612 11/10/2021
2.9.0-beta001 543 11/10/2021
2.8.1 980 11/7/2021
2.8.0 806 11/7/2021
2.8.0-beta001 596 11/7/2021
2.7.1 2,495 10/19/2021
2.7.1-beta001 547 10/19/2021
2.7.0 12,499 8/2/2021
2.7.0-beta001 590 8/2/2021
2.6.0 3,196 7/7/2021
2.6.0-beta001 544 7/7/2021
2.5.0 11,843 5/26/2021
2.5.0-beta001 617 5/26/2021
2.4.0 1,097 5/23/2021
2.4.0-beta001 585 5/23/2021
2.3.0 2,687 5/14/2021
2.3.0-beta002 549 5/14/2021
2.2.0 10,788 4/21/2021
2.1.2 25,041 2/27/2021
2.1.1 842 2/26/2021
2.1.1-beta001 587 2/26/2021
2.1.0 912 2/26/2021
2.1.0-beta003 669 2/26/2021
2.1.0-beta002 626 2/25/2021
2.1.0-beta001 629 2/25/2021
2.0.0 461,611 11/20/2020
2.0.0-beta002 727 11/18/2020
2.0.0-beta001 775 8/29/2020
1.4.3 195,947 7/22/2020
1.4.0 4,171 6/5/2020
1.3.2 1,116 6/5/2020
1.3.1 2,028 5/29/2020
1.3.1-beta001 780 5/25/2020
1.3.0 2,300 5/25/2020
1.3.0-beta006 758 5/25/2020
1.3.0-beta005 790 5/25/2020
1.3.0-beta004 776 5/12/2020
1.2.6 21,225 2/15/2020
1.2.5 15,575 10/18/2019
1.2.4 1,141 10/10/2019
1.2.3 2,057 7/22/2019
1.2.2 1,361 5/31/2019
1.2.1 1,154 5/22/2019
1.1.1 969 5/9/2019
1.1.0 1,057 5/7/2019

- [Add Task/AsyncOption defaultValue and defaultWith](https://github.com/demystifyfp/FsToolkit.ErrorHandling/pull/238) Credits @sheridanchris