FsToolkit.ErrorHandling.TaskResult 2.13.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package FsToolkit.ErrorHandling.TaskResult --version 2.13.0
NuGet\Install-Package FsToolkit.ErrorHandling.TaskResult -Version 2.13.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="2.13.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add FsToolkit.ErrorHandling.TaskResult --version 2.13.0
#r "nuget: FsToolkit.ErrorHandling.TaskResult, 2.13.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=2.13.0

// Install FsToolkit.ErrorHandling.TaskResult as a Cake Tool
#tool nuget:?package=FsToolkit.ErrorHandling.TaskResult&version=2.13.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 Badge
FsToolkit.ErrorHandling NuGet
FsToolkit.ErrorHandling.TaskResult NuGet
FsToolkit.ErrorHandling.JobResult NuGet
FsToolkit.ErrorHandling.AsyncSeq NuGet

Developing locally

Requirements
  • .NET Core SDK
    • v3.1.200 or higher
    • Install from here.
  • Node
    • v10.15.0 or LTS
    • Not required but recommend that you use NVM to easily manage multiple versions of Node
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 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-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. 
.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 was computed. 
.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)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (6)

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.15.1 4,419 1/15/2024
4.15.0 1,803 1/10/2024
4.14.0 1,907 1/2/2024
4.13.0 2,081 12/10/2023
4.13.0-beta002 565 12/10/2023
4.13.0-beta001 549 12/10/2023
4.12.0 2,465 11/27/2023
4.11.1 2,352 11/23/2023
4.11.0 6,136 11/11/2023
4.10.0 7,134 10/16/2023
4.9.0 140,698 7/10/2023
4.8.0 1,928 7/7/2023
4.7.0 6,525 6/21/2023
4.7.0-beta001 912 6/21/2023
4.6.0 22,214 4/20/2023
4.6.0-beta001 952 4/20/2023
4.5.0 6,035 3/27/2023
4.5.0-beta002 984 3/19/2023
4.5.0-beta001 1,804 3/6/2023
4.4.0 58,462 2/21/2023
4.3.0 14,282 1/20/2023
4.2.1 10,621 12/19/2022
4.2.0 1,462 12/17/2022
4.1.0 2,715 12/13/2022
4.1.0-beta001 978 12/13/2022
4.0.0 17,233 11/19/2022
4.0.0-beta001 890 11/19/2022
3.3.1 37,624 11/19/2022
3.3.1-beta004 932 11/19/2022
3.3.1-beta003 954 11/18/2022
3.3.1-beta002 995 11/18/2022
3.3.1-beta001 886 11/18/2022
3.3.0-beta001 937 11/9/2022
3.2.0 83,505 10/31/2022
3.2.0-beta001 910 10/31/2022
3.1.0 16,010 10/19/2022
3.0.1 2,175 10/18/2022
3.0.0 4,646 10/14/2022
3.0.0-beta008 987 10/14/2022
3.0.0-beta007 26,446 4/15/2022
3.0.0-beta006 1,006 4/5/2022
3.0.0-beta005 981 4/5/2022
3.0.0-beta004 1,040 4/5/2022
3.0.0-beta003 967 3/30/2022
3.0.0-beta002 946 2/21/2022
3.0.0-beta001 991 2/21/2022
2.13.0 733,905 1/11/2022
2.13.0-beta001 935 1/11/2022
2.12.0 2,021 1/6/2022
2.12.0-beta001 917 1/6/2022
2.11.1 16,517 12/1/2021
2.11.1-beta001 1,489 12/1/2021
2.11.0 4,854 11/24/2021
2.11.0-beta004 3,928 11/24/2021
2.11.0-beta002 3,815 11/24/2021
2.11.0-beta001 3,706 11/24/2021
2.10.0 14,000 11/13/2021
2.9.0 2,089 11/10/2021
2.9.0-beta001 1,026 11/10/2021
2.8.1 1,461 11/7/2021
2.8.0 1,347 11/7/2021
2.8.0-beta001 1,099 11/7/2021
2.7.1 2,981 10/19/2021
2.7.1-beta001 1,029 10/19/2021
2.7.0 13,135 8/2/2021
2.7.0-beta001 1,053 8/2/2021
2.6.0 3,653 7/7/2021
2.6.0-beta001 1,008 7/7/2021
2.5.0 13,017 5/26/2021
2.5.0-beta001 1,134 5/26/2021
2.4.0 1,557 5/23/2021
2.4.0-beta001 1,038 5/23/2021
2.3.0 3,177 5/14/2021
2.3.0-beta002 1,023 5/14/2021
2.2.0 11,297 4/21/2021
2.1.2 26,461 2/27/2021
2.1.1 1,360 2/26/2021
2.1.1-beta001 1,096 2/26/2021
2.1.0 1,430 2/26/2021
2.1.0-beta003 1,173 2/26/2021
2.1.0-beta002 1,131 2/25/2021
2.1.0-beta001 1,149 2/25/2021
2.0.0 492,639 11/20/2020
2.0.0-beta002 1,276 11/18/2020
2.0.0-beta001 1,327 8/29/2020
1.4.3 203,536 7/22/2020
1.4.0 4,837 6/5/2020
1.3.2 1,692 6/5/2020
1.3.1 2,558 5/29/2020
1.3.1-beta001 1,333 5/25/2020
1.3.0 3,037 5/25/2020
1.3.0-beta006 1,297 5/25/2020
1.3.0-beta005 1,368 5/25/2020
1.3.0-beta004 1,270 5/12/2020
1.2.6 22,315 2/15/2020
1.2.5 16,527 10/18/2019
1.2.4 1,670 10/10/2019
1.2.3 2,584 7/22/2019
1.2.2 1,935 5/31/2019
1.2.1 1,734 5/22/2019
1.1.1 1,473 5/9/2019
1.1.0 1,621 5/7/2019

- [Option/ValueOption.ofNull and bindNull](https://github.com/demystifyfp/FsToolkit.ErrorHandling/pull/164) Credits [@TheAngryByrd](https://github.com/TheAngryByrd)