mapError

Namespace: FsToolkit.ErrorHandling

mapError takes a result and a normal function and returns a new result value based on the input error value and the function

Function Signature

('errorInput -> 'errorOutput) -> Result<'ok, 'errorInput> 
    -> Result<'ok, 'errorOutput>

Examples

Take the following functions for example

// string -> int
let getErrorCode (message: string) =
    match message with
    | "bad things happened" -> 1
    | _ -> 0

Example 1

let result =
    Ok "bad things happened" // Result<string, string>
    |> ResultOption.mapError getErrorCode // Result<string, int>

// Ok "bad things happened"

Example 2

let result =
    Error "bad things happened" // Result<string, string>
    |> ResultOption.mapError getErrorCode // Result<string, int>

// Error 1