FsToolkit.ErrorHandling.JobResult 5.0.0-beta004

This is a prerelease version of FsToolkit.ErrorHandling.JobResult.
There is a newer version of this package available.
See the version list below for details.
dotnet add package FsToolkit.ErrorHandling.JobResult --version 5.0.0-beta004
                    
NuGet\Install-Package FsToolkit.ErrorHandling.JobResult -Version 5.0.0-beta004
                    
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.JobResult" Version="5.0.0-beta004" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="FsToolkit.ErrorHandling.JobResult" Version="5.0.0-beta004" />
                    
Directory.Packages.props
<PackageReference Include="FsToolkit.ErrorHandling.JobResult" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add FsToolkit.ErrorHandling.JobResult --version 5.0.0-beta004
                    
#r "nuget: FsToolkit.ErrorHandling.JobResult, 5.0.0-beta004"
                    
#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.
#:package FsToolkit.ErrorHandling.JobResult@5.0.0-beta004
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=FsToolkit.ErrorHandling.JobResult&version=5.0.0-beta004&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=FsToolkit.ErrorHandling.JobResult&version=5.0.0-beta004&prerelease
                    
Install as a Cake Tool

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, .NET Standard2.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-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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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)
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
5.0.1 101 7/12/2025
5.0.0 160 6/2/2025
5.0.0-beta014 143 6/2/2025
5.0.0-beta013 142 5/29/2025
5.0.0-beta012 148 5/1/2025
5.0.0-beta011 160 3/30/2025
5.0.0-beta010 121 3/21/2025
5.0.0-beta009 208 3/5/2025
5.0.0-beta008 110 3/2/2025
5.0.0-beta007 99 2/23/2025
5.0.0-beta006 101 2/21/2025
5.0.0-beta005 104 2/16/2025
5.0.0-beta004 113 2/4/2025
5.0.0-beta003 103 1/6/2025
5.0.0-beta002 108 12/21/2024
5.0.0-beta001 114 12/7/2024
4.18.0 234 10/23/2024
4.18.0-beta001 100 10/23/2024
4.17.0 168 9/23/2024
4.17.0-beta002 98 9/23/2024
4.17.0-beta001 112 9/23/2024
4.16.0 166 7/15/2024
4.15.3 151 7/14/2024
4.15.3-beta001 108 7/14/2024
4.15.2 153 5/2/2024
4.15.2-beta001 88 5/2/2024
4.15.1 241 1/15/2024
4.15.0 175 1/10/2024
4.14.0 177 1/2/2024
4.13.0 214 12/10/2023
4.13.0-beta002 129 12/10/2023
4.13.0-beta001 139 12/10/2023
4.12.0 185 11/27/2023
4.11.1 155 11/23/2023
4.11.0 173 11/11/2023
4.10.0 192 10/16/2023
4.9.0 262 7/10/2023
4.8.0 207 7/7/2023
4.7.0 228 6/21/2023
4.7.0-beta001 164 6/21/2023
4.6.0 261 4/20/2023
4.6.0-beta001 184 4/20/2023
4.5.0 284 3/27/2023
4.5.0-beta002 199 3/19/2023
4.5.0-beta001 184 3/6/2023
4.4.0 339 2/21/2023
4.3.0 381 1/20/2023
4.2.1 368 12/19/2022
4.2.0 399 12/17/2022
4.1.0 337 12/13/2022
4.1.0-beta001 191 12/13/2022
4.0.0 431 11/19/2022
4.0.0-beta001 207 11/19/2022
3.3.1 412 11/19/2022
3.3.1-beta004 192 11/19/2022
3.3.1-beta003 208 11/18/2022
3.3.1-beta002 203 11/18/2022
3.3.1-beta001 204 11/18/2022
3.3.0-beta001 216 11/9/2022
3.2.0 467 10/31/2022
3.2.0-beta001 200 10/31/2022
3.1.0 494 10/19/2022
3.0.1 430 10/18/2022
3.0.0 446 10/14/2022
3.0.0-beta008 217 10/14/2022
3.0.0-beta007 259 4/15/2022
3.0.0-beta006 233 4/5/2022
3.0.0-beta005 224 4/5/2022
3.0.0-beta004 227 4/5/2022
3.0.0-beta003 226 3/30/2022
3.0.0-beta002 231 2/21/2022
3.0.0-beta001 225 2/21/2022
2.13.0 635 1/11/2022
2.13.0-beta001 250 1/11/2022
2.12.0 379 1/6/2022
2.12.0-beta001 250 1/6/2022
2.11.1 1,023 12/1/2021
2.11.1-beta001 849 12/1/2021
2.11.0 3,393 11/24/2021
2.11.0-beta004 3,288 11/24/2021
2.11.0-beta002 3,184 11/24/2021
2.11.0-beta001 3,075 11/24/2021
2.10.0 433 11/13/2021
2.9.0 428 11/10/2021
2.9.0-beta001 280 11/10/2021
2.8.1 464 11/7/2021
2.8.0 460 11/7/2021
2.8.0-beta001 363 11/7/2021
2.7.1 464 10/19/2021
2.7.1-beta001 318 10/19/2021
2.7.0 620 8/2/2021
2.7.0-beta001 335 8/2/2021
2.6.0 433 7/7/2021
2.6.0-beta001 331 7/7/2021
2.5.0 527 5/26/2021
2.5.0-beta001 309 5/26/2021
2.4.0 467 5/23/2021
2.4.0-beta001 321 5/23/2021
2.3.0 423 5/14/2021
2.3.0-beta002 312 5/14/2021
2.2.0 447 4/21/2021
2.1.2 517 2/27/2021
2.1.1 458 2/26/2021
2.1.1-beta001 315 2/26/2021
2.1.0 532 2/26/2021
2.1.0-beta003 399 2/26/2021
2.1.0-beta002 351 2/25/2021
2.1.0-beta001 351 2/25/2021
2.0.0 858 11/20/2020
2.0.0-beta002 466 11/18/2020
2.0.0-beta001 457 8/29/2020
1.4.3 915 7/22/2020
1.4.0 691 6/5/2020
1.3.2 650 6/5/2020
1.3.1 686 5/29/2020
1.3.1-beta001 501 5/25/2020
1.3.0 699 5/25/2020
1.3.0-beta006 497 5/25/2020
1.3.0-beta005 531 5/25/2020
1.3.0-beta004 481 5/12/2020
1.2.6 747 2/15/2020
1.2.5 765 10/18/2019
1.2.4 683 10/10/2019
1.2.3 788 7/22/2019
1.2.2 760 5/31/2019
1.2.1 772 5/22/2019

- BREAKING: [Remove Ply and update to FSharp 6](https://github.com/demystifyfp/FsToolkit.ErrorHandling/pull/248) Credits @TheAngryByrd
- BREAKING: [Remove MergeSources (and!) from some implementations like Result](https://github.com/demystifyfp/FsToolkit.ErrorHandling/pull/261)  Credits @TheAngryByrd
- BREAKING: [Merge TaskResult into Core library](https://github.com/demystifyfp/FsToolkit.ErrorHandling/pull/285) Credits @TheAngryByrd
- This means FsToolkit.ErrorHandling.TaskResult is no longer a separate package and will not be updated. It is now part of the core library.
- BREAKING: [Rename retn to singleton](https://github.com/demystifyfp/FsToolkit.ErrorHandling/pull/287) Credits @1eyewonder
- [Use Microsoft.Bcl.AsyncInterfaces in netstandard2.0 (Allows IAsyncDisposable and IAsyncEnumerable)](https://github.com/demystifyfp/FsToolkit.ErrorHandling/pull/250) Credits @TheAngryByrd
- [Build against Net8](https://github.com/demystifyfp/FsToolkit.ErrorHandling/pull/251) Credits @TheAngryByrd
- [Fix Overload Resolution to Align to Computation Expression used](https://github.com/demystifyfp/FsToolkit.ErrorHandling/pull/252) Credits @TheAngryByrd
- [refactor!: Seq.sequenceResultM returns Array instead of seq](https://github.com/demystifyfp/FsToolkit.ErrorHandling/pull/255) Credits @bartelink
- [feat(Seq): sequenceResultA](https://github.com/demystifyfp/FsToolkit.ErrorHandling/pull/255) Credits @bartelink
- [Updated uses of Seq.append](https://github.com/demystifyfp/FsToolkit.ErrorHandling/pull/290) Credits @1eyewonder
- [Add Option.traverseAsync and Option.sequenceAsync](https://github.com/demystifyfp/FsToolkit.ErrorHandling/pull/298#event-15827853276) Credits @tw0po1nt
- [Add Require and Check helper methods](https://github.com/demystifyfp/FsToolkit.ErrorHandling/pull/295) Credits @PI-Gorbo
- [Add new AsyncOption APIs and document all its other functions; minor fixes to documentation for Option module](https://github.com/demystifyfp/FsToolkit.ErrorHandling/pull/307) Credits @tw0po1nt