FsToolkit.ErrorHandling.JobResult 3.3.1-beta002

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

// Install FsToolkit.ErrorHandling.JobResult as a Cake Tool
#tool nuget:?package=FsToolkit.ErrorHandling.JobResult&version=3.3.1-beta002&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 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. 
.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.0-beta009 161 5 days ago
5.0.0-beta008 83 7 days ago
5.0.0-beta007 73 15 days ago
5.0.0-beta006 73 16 days ago
5.0.0-beta005 76 22 days ago
5.0.0-beta004 85 a month ago
5.0.0-beta003 75 2 months ago
5.0.0-beta002 78 3 months ago
5.0.0-beta001 91 3 months ago
4.18.0 175 4 months ago
4.18.0-beta001 74 4 months ago
4.17.0 129 5 months ago
4.17.0-beta002 77 5 months ago
4.17.0-beta001 82 5 months ago
4.16.0 118 8 months ago
4.15.3 111 8 months ago
4.15.3-beta001 84 8 months ago
4.15.2 110 5/2/2024
4.15.2-beta001 71 5/2/2024
4.15.1 185 1/15/2024
4.15.0 139 1/10/2024
4.14.0 136 1/2/2024
4.13.0 171 12/10/2023
4.13.0-beta002 116 12/10/2023
4.13.0-beta001 124 12/10/2023
4.12.0 163 11/27/2023
4.11.1 142 11/23/2023
4.11.0 150 11/11/2023
4.10.0 168 10/16/2023
4.9.0 224 7/10/2023
4.8.0 171 7/7/2023
4.7.0 186 6/21/2023
4.7.0-beta001 130 6/21/2023
4.6.0 216 4/20/2023
4.6.0-beta001 139 4/20/2023
4.5.0 247 3/27/2023
4.5.0-beta002 162 3/19/2023
4.5.0-beta001 143 3/6/2023
4.4.0 308 2/21/2023
4.3.0 340 1/20/2023
4.2.1 331 12/19/2022
4.2.0 367 12/17/2022
4.1.0 305 12/13/2022
4.1.0-beta001 148 12/13/2022
4.0.0 387 11/19/2022
4.0.0-beta001 173 11/19/2022
3.3.1 370 11/19/2022
3.3.1-beta004 155 11/19/2022
3.3.1-beta003 168 11/18/2022
3.3.1-beta002 165 11/18/2022
3.3.1-beta001 162 11/18/2022
3.3.0-beta001 181 11/9/2022
3.2.0 422 10/31/2022
3.2.0-beta001 159 10/31/2022
3.1.0 454 10/19/2022
3.0.1 388 10/18/2022
3.0.0 410 10/14/2022
3.0.0-beta008 175 10/14/2022
3.0.0-beta007 199 4/15/2022
3.0.0-beta006 183 4/5/2022
3.0.0-beta005 180 4/5/2022
3.0.0-beta004 180 4/5/2022
3.0.0-beta003 174 3/30/2022
3.0.0-beta002 178 2/21/2022
3.0.0-beta001 176 2/21/2022
2.13.0 574 1/11/2022
2.13.0-beta001 196 1/11/2022
2.12.0 320 1/6/2022
2.12.0-beta001 192 1/6/2022
2.11.1 970 12/1/2021
2.11.1-beta001 794 12/1/2021
2.11.0 3,342 11/24/2021
2.11.0-beta004 3,227 11/24/2021
2.11.0-beta002 3,124 11/24/2021
2.11.0-beta001 3,015 11/24/2021
2.10.0 375 11/13/2021
2.9.0 365 11/10/2021
2.9.0-beta001 224 11/10/2021
2.8.1 410 11/7/2021
2.8.0 405 11/7/2021
2.8.0-beta001 308 11/7/2021
2.7.1 406 10/19/2021
2.7.1-beta001 263 10/19/2021
2.7.0 558 8/2/2021
2.7.0-beta001 282 8/2/2021
2.6.0 378 7/7/2021
2.6.0-beta001 277 7/7/2021
2.5.0 461 5/26/2021
2.5.0-beta001 253 5/26/2021
2.4.0 408 5/23/2021
2.4.0-beta001 263 5/23/2021
2.3.0 369 5/14/2021
2.3.0-beta002 253 5/14/2021
2.2.0 389 4/21/2021
2.1.2 447 2/27/2021
2.1.1 398 2/26/2021
2.1.1-beta001 253 2/26/2021
2.1.0 457 2/26/2021
2.1.0-beta003 334 2/26/2021
2.1.0-beta002 292 2/25/2021
2.1.0-beta001 284 2/25/2021
2.0.0 792 11/20/2020
2.0.0-beta002 407 11/18/2020
2.0.0-beta001 392 8/29/2020
1.4.3 854 7/22/2020
1.4.0 622 6/5/2020
1.3.2 588 6/5/2020
1.3.1 617 5/29/2020
1.3.1-beta001 432 5/25/2020
1.3.0 632 5/25/2020
1.3.0-beta006 424 5/25/2020
1.3.0-beta005 469 5/25/2020
1.3.0-beta004 413 5/12/2020
1.2.6 677 2/15/2020
1.2.5 689 10/18/2019
1.2.4 613 10/10/2019
1.2.3 716 7/22/2019
1.2.2 692 5/31/2019
1.2.1 697 5/22/2019

- [FSharp.Core version warning](https://github.com/demystifyfp/FsToolkit.ErrorHandling/issues/194). Credits @TheAngryByrd