diff --git a/gitbook/SUMMARY.md b/gitbook/SUMMARY.md index b7c949c9..9a225048 100644 --- a/gitbook/SUMMARY.md +++ b/gitbook/SUMMARY.md @@ -12,7 +12,6 @@ * [map2](result/map2.md) * [map3](result/map3.md) * [mapError](result/mapError.md) - * [ofChoice](result/ofChoice.md) * [Operators](result/operators.md) * [orElse Functions](result/orElseFunctions.md) * [Other Functions](result/others.md) @@ -26,6 +25,8 @@ * [sequenceResultM](list/sequenceResultM.md) * [traverseResultA](list/traverseResultA.md) * [sequenceResultA](list/sequenceResultA.md) + * Transforms + * [ofChoice](result/ofChoice.md) * Option * [bind](pr.md) @@ -33,13 +34,16 @@ * [Computation Expression](option/ce.md) * [either](pr.md) * [map](pr.md) - * [ofPair](pr.md) - * [ofValueOption](pr.md) - * [toValueOption](pr.md) * [zip](pr.md) * Lists * [traverseResult](option/traverseResult.md) * [sequenceResult](option/sequenceResult.md) + * Transforms + * [ofNull](option/ofNull.md) + * [ofPair](option/ofPair.md) + * [ofResult](option/ofResult.md) + * [ofValueOption](option/ofValueOption.md) + * [toValueOption](option/toValueOption.md) * ResultOption * [apply](resultOption/apply.md) @@ -50,12 +54,13 @@ * [map2](resultOption/map2.md) * [map3](resultOption/map3.md) * [mapError](pr.md) - * [ofResult](pr.md) - * [ofOption](pr.md) - * [ofChoice](pr.md) * [Operators](resultOption/operators.md) * [zip](resultOption/zip.md) * [zipError](resultOption/zipError.md) + * Transforms + * [ofChoice](resultOption/ofChoice.md) + * [ofOption](resultOption/ofOption.md) + * [ofResult](resultOption/ofResult.md) * AsyncResult * [apply](asyncResult/apply.md) @@ -68,10 +73,6 @@ * [map2](asyncResult/map2.md) * [map3](asyncResult/map3.md) * [mapError](asyncResult/mapError.md) - * [ofAsync](pr.md) - * [ofResult](pr.md) - * [ofTask](asyncResult/ofTask.md) - * [ofTaskAction](asyncResult/ofTaskAction.md) * [Operators](asyncResult/operators.md) * [Other Functions](asyncResult/others.md) * [zip](pr.md) @@ -81,6 +82,11 @@ * [sequenceAsyncResultM](list/sequenceAsyncResultM.md) * [traverseAsyncResultA](list/traverseAsyncResultA.md) * [sequenceAsyncResultA](list/sequenceAsyncResultA.md) + * Transforms + * [ofAsync](asyncResult/ofAsync.md) + * [ofResult](asyncResult/ofResult.md) + * [ofTask](asyncResult/ofTask.md) + * [ofTaskAction](asyncResult/ofTaskAction.md) * AsyncResultOption * [apply](asyncResultOption/apply.md) @@ -90,11 +96,12 @@ * [map](asyncResultOption/map.md) * [map2](asyncResultOption/map2.md) * [map3](asyncResultOption/map3.md) - * [ofAsyncOption](pr.md) - * [ofAsyncResult](pr.md) - * [ofOption](pr.md) - * [ofResult](pr.md) * [Operators](asyncResultOption/operators.md) + * Transforms + * [ofAsyncOption](asyncResultOption/ofAsyncOption.md) + * [ofAsyncResult](asyncResultOption/ofAsyncResult.md) + * [ofOption](asyncResultOption/ofOption.md) + * [ofResult](asyncResultOption/ofResult.md) * [Validation](validation/index.md) * [apply](validation/apply.md) @@ -105,11 +112,12 @@ * [map3](validation/map3.md) * [mapError](pr.md) * [mapErrors](pr.md) - * [ofChoice](pr.md) - * [ofResult](validation/ofResult.md) * [Operators](validation/operators.md) * [returnError](pr.md) * [zip](pr.md) + * Transforms + * [ofChoice](validation/ofChoice.md) + * [ofResult](validation/ofResult.md) * [AsyncValidation](asyncValidation/index.md) * [apply](asyncValidation/apply.md) @@ -120,11 +128,12 @@ * [map3](asyncValidation/map3.md) * [mapError](pr.md) * [mapErrors](pr.md) - * [ofChoice](pr.md) - * [ofResult](asyncValidation/ofResult.md) * [Operators](asyncValidation/operators.md) * [returnError](pr.md) * [zip](pr.md) + * Transforms + * [ofChoice](asyncValidation/ofChoice.md) + * [ofResult](asyncValidation/ofResult.md) * FsToolkit.ErrorHandling.AsyncSeq * AsyncSeq @@ -153,11 +162,12 @@ * [map3](cancellableTaskValidation/map3.md) * [mapError](pr.md) * [mapErrors](pr.md) - * [ofChoice](pr.md) - * [ofResult](pr.md) * [Operators](cancellableTaskValidation/operators.md) * [zip](pr.md) * [parallelZip](pr.md) + * Transforms + * [ofChoice](cancellableTaskValidation/ofChoice.md) + * [ofResult](cancellableTaskValidation/ofResult.md) * FsToolkit.ErrorHandling.JobResult * Job @@ -187,10 +197,6 @@ * [map2](jobResult/map2.md) * [map3](jobResult/map3.md) * [mapError](jobResult/mapError.md) - * [ofAsync](pr.md) - * [ofJob](pr.md) - * [ofResult](pr.md) - * [ofTask](jobResult/ofTask.md) * [Operators](jobResult/operators.md) * [Other Functions](jobResult/others.md) * [returnError](pr.md) @@ -201,6 +207,12 @@ * [sequenceJobResultM](pr.md) * [traverseJobResultA](pr.md) * [sequenceJobResultA](pr.md) + * Transforms + * [ofAsync](jobResult/ofAsync.md) + * [ofJob](jobResult/ofJob.md) + * [ofResult](jobResult/ofResult.md) + * [fromTask](jobResult/fromTask.md) + * [fromUnitTask](jobResult/fromUnitTask.md) * JobResultOption * [apply](pr.md) @@ -225,6 +237,8 @@ * [map3](pr.md) * [ofUnit](pr.md) * [zip](pr.md) + * Transforms + * [ofUnit](task/ofUnit.md) * TaskOption * [apply](pr.md) @@ -245,9 +259,6 @@ * [map2](taskResult/map2.md) * [map3](taskResult/map3.md) * [mapError](taskResult/mapError.md) - * [ofAsync](pr.md) - * [ofResult](pr.md) - * [ofTask](pr.md) * [Operators](taskResult/operators.md) * [Other Functions](taskResult/others.md) * [returnError](pr.md) @@ -258,6 +269,10 @@ * [sequenceTaskResultM](list/sequenceTaskResultM.md) * [traverseTaskResultA](list/traverseTaskResultA.md) * [sequenceTaskResultA](list/sequenceTaskResultA.md) + * Transforms + * [ofAsync](taskResult/ofAsync.md) + * [ofResult](taskResult/ofResult.md) + * [ofTask](taskResult/ofTask.md) * TaskResultOption * [apply](taskResultOption/apply.md) diff --git a/gitbook/asyncResult/ofAsync.md b/gitbook/asyncResult/ofAsync.md new file mode 100644 index 00000000..c533687d --- /dev/null +++ b/gitbook/asyncResult/ofAsync.md @@ -0,0 +1,20 @@ +# AsyncResult.ofAsync + +Namespace: `FsToolkit.ErrorHandling` + +Transforms a `Async<'T>` into an `Async>`. + +## Function Signature + +```fsharp +Async<'T> -> Async> +``` + +## Examples + +### Example 1 + +```fsharp +let result = AsyncResult.ofAsync (async { return 42 }) +// async { return Ok 42 } +``` diff --git a/gitbook/asyncResult/ofResult.md b/gitbook/asyncResult/ofResult.md new file mode 100644 index 00000000..a6d0e82b --- /dev/null +++ b/gitbook/asyncResult/ofResult.md @@ -0,0 +1,27 @@ +# AsyncResult.ofResult + +Namespace: `FsToolkit.ErrorHandling` + +Transforms a `Result<'T, 'Error>` into an `Async>`. + +## Function Signature + +```fsharp +Result<'T, 'Error> -> Async> +``` + +## Examples + +### Example 1 + +```fsharp +let result = AsyncResult.ofResult (Ok 42) +// async { return Ok 42 } +``` + +### Example 2 + +```fsharp +let result = AsyncResult.ofResult (Error "Boom!") +// async { return Error "Boom!" } +``` diff --git a/gitbook/asyncResult/ofTask.md b/gitbook/asyncResult/ofTask.md index 45110633..c7d779eb 100644 --- a/gitbook/asyncResult/ofTask.md +++ b/gitbook/asyncResult/ofTask.md @@ -1,12 +1,27 @@ -## AsyncResult.ofTask +# AsyncResult.ofTask Namespace: `FsToolkit.ErrorHandling` -Function Signature: +Transforms a `Task<'T>` into an `Async>`. + +## Function Signature ```fsharp -Task<'a> -> Async> +Task<'T> -> Async> ``` ## Examples +### Example 1 + +```fsharp +let result = AsyncResult.ofTask (Task.FromResult 42) +// async { return Ok 42 } +``` + +### Example 2 + +```fsharp +let result = AsyncResult.ofTask (Task.FromException (System.Exception("Boom!"))) +// async { return Error (System.Exception("Boom!")) } +``` diff --git a/gitbook/asyncResult/ofTaskAction.md b/gitbook/asyncResult/ofTaskAction.md index 9d173f5a..c84f5875 100644 --- a/gitbook/asyncResult/ofTaskAction.md +++ b/gitbook/asyncResult/ofTaskAction.md @@ -1,12 +1,27 @@ -## AsyncResult.ofTaskAction +# AsyncResult.ofTaskAction Namespace: `FsToolkit.ErrorHandling` -Function Signature: +Transforms a `Task` into an `Async>`. + +## Function Signature ```fsharp -Task -> Async> +Task -> Async> ``` ## Examples +### Example 1 + +```fsharp +let result = AsyncResult.ofTaskAction (Task.Delay 1000) +// async { do () } +``` + +### Example 2 + +```fsharp +let result = AsyncResult.ofTaskAction (Task.FromException (System.Exception("Boom!"))) +// async { return Error (System.Exception("Boom!")) } +``` diff --git a/gitbook/asyncResultOption/ofAsyncOption.md b/gitbook/asyncResultOption/ofAsyncOption.md new file mode 100644 index 00000000..3770d00e --- /dev/null +++ b/gitbook/asyncResultOption/ofAsyncOption.md @@ -0,0 +1,27 @@ +# AsyncResultOption.ofAsyncOption + +Namespace: `FsToolkit.ErrorHandling` + +Transforms a `Async<'T option>` into an `Async>`. + +## Function Signature + +```fsharp +Async<'T option> -> Async> +``` + +## Examples + +### Example 1 + +```fsharp +let result = AsyncResultOption.ofAsyncOption (async { return Some 42 }) +// async { return Ok (Some 42) } +``` + +### Example 2 + +```fsharp +let result = AsyncResultOption.ofAsyncOption (async { return None }) +// async { return Ok None } +``` diff --git a/gitbook/asyncResultOption/ofAsyncResult.md b/gitbook/asyncResultOption/ofAsyncResult.md new file mode 100644 index 00000000..a49d6acb --- /dev/null +++ b/gitbook/asyncResultOption/ofAsyncResult.md @@ -0,0 +1,27 @@ +# AsyncResultOption.ofAsyncResult + +Namespace: `FsToolkit.ErrorHandling` + +Transforms a `Async>` into an `Async>`. + +## Function Signature + +```fsharp +Async> -> Async> +``` + +## Examples + +### Example 1 + +```fsharp +let result = AsyncResult.ofAsyncResult (async { return Ok 42 }) +// async { return Ok (Some 42) } +``` + +### Example 2 + +```fsharp +let result = AsyncResult.ofAsyncResult (async { return Error "error" }) +// async { return Error "error" } +``` diff --git a/gitbook/asyncResultOption/ofOption.md b/gitbook/asyncResultOption/ofOption.md new file mode 100644 index 00000000..faec7454 --- /dev/null +++ b/gitbook/asyncResultOption/ofOption.md @@ -0,0 +1,27 @@ +# AsyncResultOption.ofOption + +Namespace: `FsToolkit.ErrorHandling` + +Transforms a `'T option` into an `Async>`. + +## Function Signature + +```fsharp +'T option -> Async> +``` + +## Examples + +### Example 1 + +```fsharp +let result = AsyncResultOption.ofOption (Some 42) +// async { return Ok (Some 42) } +``` + +### Example 2 + +```fsharp +let result = AsyncResultOption.ofOption None +// async { return Ok None } +``` diff --git a/gitbook/asyncResultOption/ofResult.md b/gitbook/asyncResultOption/ofResult.md new file mode 100644 index 00000000..d71561ff --- /dev/null +++ b/gitbook/asyncResultOption/ofResult.md @@ -0,0 +1,27 @@ +# AsyncResultOption.ofResult + +Namespace: `FsToolkit.ErrorHandling` + +Transforms a `Result<'T, 'Error>` into an `Async>`. + +## Function Signature + +```fsharp +Result<'T, 'Error> -> Async> +``` + +## Examples + +### Example 1 + +```fsharp +let result = AsyncResultOption.ofResult (Ok 42) +// async { return Ok (Some 42) } +``` + +### Example 2 + +```fsharp +let result = AsyncResultOption.ofResult (Error "error") +// async { return Error "error" } +``` diff --git a/gitbook/asyncValidation/ofChoice.md b/gitbook/asyncValidation/ofChoice.md new file mode 100644 index 00000000..4132b087 --- /dev/null +++ b/gitbook/asyncValidation/ofChoice.md @@ -0,0 +1,27 @@ +# AsyncValidation.ofChoice + +Namespace: `FsToolkit.ErrorHandling` + +Transforms a `Choice<'T, 'Error>` into a `Async>` + +## Function Signature + +```fsharp +Choice<'T, 'Error> -> Async> +``` + +## Examples + +### Example 1 + +```fsharp +let result = AsyncValidation.ofChoice (Choice1Of2 42) +// async { return Ok 42 } +``` + +### Example 2 + +```fsharp +let result = AsyncValidation.ofChoice (Choice2Of2 "error") +// async { return Error ["error"] } +``` diff --git a/gitbook/asyncValidation/ofResult.md b/gitbook/asyncValidation/ofResult.md index 297ac688..d0ce40a9 100644 --- a/gitbook/asyncValidation/ofResult.md +++ b/gitbook/asyncValidation/ofResult.md @@ -1,13 +1,27 @@ -## AsyncValidation.ofResult +# AsyncValidation.ofResult Namespace: `FsToolkit.ErrorHandling` -Function Signature: +Transforms a `Result<'T, 'Error>` into a `Async>` + +## Function Signature ```fsharp -Result<'a, 'b> -> Async> +Result<'T, 'Error> -> Async> ``` -Simply wraps the error in a list and makes the result async. - ## Examples + +### Example 1 + +```fsharp +let result = AsyncValidation.ofResult (Ok 42) +// async { return Ok 42 } +``` + +### Example 2 + +```fsharp +let result = AsyncValidation.ofResult (Error "error") +// async { return Error ["error"] } +``` diff --git a/gitbook/cancellableTaskValidation/ofChoice.md b/gitbook/cancellableTaskValidation/ofChoice.md new file mode 100644 index 00000000..6936af71 --- /dev/null +++ b/gitbook/cancellableTaskValidation/ofChoice.md @@ -0,0 +1,27 @@ +# CancellableTaskValidation.ofResult + +Namespace: `FsToolkit.ErrorHandling` + +Transforms a `Choice<'T, 'Error>` into a `CancellableTask>` + +## Function Signature + +```fsharp +Choice<'T, 'Error> -> CancellableTask> +``` + +## Examples + +### Example 1 + +```fsharp +let result = CancellableTaskValidation.ofChoice (Choice1Of2 42) +// cancellableTask { return Ok 42 } +``` + +### Example 2 + +```fsharp +let result = CancellableTaskValidation.ofChoice (Choice2Of2 "error") +// cancellableTask { return Error ["error"] } +``` diff --git a/gitbook/cancellableTaskValidation/ofResult.md b/gitbook/cancellableTaskValidation/ofResult.md index e04cc4fd..2f560fb1 100644 --- a/gitbook/cancellableTaskValidation/ofResult.md +++ b/gitbook/cancellableTaskValidation/ofResult.md @@ -1,13 +1,27 @@ -## CancellableTaskValidation.ofResult +# CancellableTaskValidation.ofResult Namespace: `FsToolkit.ErrorHandling` -Function Signature: +Transforms a `Result<'T, 'Error>` into a `CancellableTask>` + +## Function Signature ```fsharp -Result<'a, 'b> -> CancellableTask> +Result<'T, 'Error> -> CancellableTask> ``` -Simply wraps the error in a list and makes the result a cancellable task. - ## Examples + +### Example 1 + +```fsharp +let result = CancellableTaskValidation.ofResult (Ok 42) +// cancellableTask { return Ok 42 } +``` + +### Example 2 + +```fsharp +let result = CancellableTaskValidation.ofResult (Error "error") +// cancellableTask { return Error ["error"] } +``` diff --git a/gitbook/jobResult/fromTask.md b/gitbook/jobResult/fromTask.md new file mode 100644 index 00000000..5727c480 --- /dev/null +++ b/gitbook/jobResult/fromTask.md @@ -0,0 +1,27 @@ +# JobResult.fromTask + +Namespace: `FsToolkit.ErrorHandling` + +Transforms a `Task<'T>` into a `Job>` + +## Function Signature + +```fsharp +Task<'T> -> Job> +``` + +## Examples + +### Example 1 + +```fsharp +let result = JobResult.fromTask (task { return 42 }) +// job { return Ok 42 } +``` + +### Example 2 + +```fsharp +let result = JobResult.fromTask (task { return System.Exception("error") }) +// job { return Error "error" } +``` diff --git a/gitbook/jobResult/fromUnitTask.md b/gitbook/jobResult/fromUnitTask.md new file mode 100644 index 00000000..8fbab891 --- /dev/null +++ b/gitbook/jobResult/fromUnitTask.md @@ -0,0 +1,27 @@ +# JobResult.fromTask + +Namespace: `FsToolkit.ErrorHandling` + +Transforms a `Task` into a `Job>` + +## Function Signature + +```fsharp +Task -> Job> +``` + +## Examples + +### Example 1 + +```fsharp +let result = JobResult.fromUnitTask (task { return () }) +// job { return Ok () } +``` + +### Example 2 + +```fsharp +let result = JobResult.fromUnitTask (task { return System.Exception("error") }) +// job { return Error "error" } +``` diff --git a/gitbook/jobResult/ofAsync.md b/gitbook/jobResult/ofAsync.md new file mode 100644 index 00000000..ebd113bb --- /dev/null +++ b/gitbook/jobResult/ofAsync.md @@ -0,0 +1,27 @@ +# JobResult.ofAsync + +Namespace: `FsToolkit.ErrorHandling` + +Transforms a `Async<'T>` into an `Job>`. + +## Function Signature + +```fsharp +Async<'T> -> Job> +``` + +## Examples + +### Example 1 + +```fsharp +let result = JobResult.ofAsync (async { return 42 }) +// job { return Ok 42 } +``` + +### Example 2 + +```fsharp +let result = JobResult.ofAsync (async { return System.Exception("error") }) +// job { return Error System.Exception("error") } +``` diff --git a/gitbook/jobResult/ofJob.md b/gitbook/jobResult/ofJob.md new file mode 100644 index 00000000..332a8897 --- /dev/null +++ b/gitbook/jobResult/ofJob.md @@ -0,0 +1,20 @@ +# JobResult.ofJob + +Namespace: `FsToolkit.ErrorHandling` + +Transforms a `Job<'T>` into an `Job>`. + +## Function Signature + +```fsharp +Job<'T> -> Job> +``` + +## Examples + +### Example 1 + +```fsharp +let result = JobResult.ofJob (job { return 42 }) +// job { return Ok 42 } +``` diff --git a/gitbook/jobResult/ofResult.md b/gitbook/jobResult/ofResult.md new file mode 100644 index 00000000..21bd6fc2 --- /dev/null +++ b/gitbook/jobResult/ofResult.md @@ -0,0 +1,27 @@ +# JobResult.ofResult + +Namespace: `FsToolkit.ErrorHandling` + +Transforms a `Result<'T, 'Error>` into an `Job>`. + +## Function Signature + +```fsharp +Result<'T, 'Error> -> Job> +``` + +## Examples + +### Example 1 + +```fsharp +let result = JobResult.ofResult (Ok 42) +// job { return Ok 42 } +``` + +### Example 2 + +```fsharp +let result = JobResult.ofResult (Error "error") +// job { return Error "error" } +``` diff --git a/gitbook/jobResult/ofTask.md b/gitbook/jobResult/ofTask.md deleted file mode 100644 index d40a09d4..00000000 --- a/gitbook/jobResult/ofTask.md +++ /dev/null @@ -1,12 +0,0 @@ -## JobResult.ofTask - -Namespace: `FsToolkit.ErrorHandling` - -Function Signature: - -```fsharp -Task<'a> -> Job> -``` - -## Examples - diff --git a/gitbook/option/ofNull.md b/gitbook/option/ofNull.md new file mode 100644 index 00000000..b5d0c923 --- /dev/null +++ b/gitbook/option/ofNull.md @@ -0,0 +1,28 @@ +# Option.ofNull + +Namespace: `FsToolkit.ErrorHandling` + +Transforms a `nullableValue` value to `'nullableValue Option`. + +## Function Signature + +```fsharp +'nullableValue -> 'nullableValue Option +``` + +## Examples + +### Example 1 + +```fsharp +let opt = Option.ofNull 1 +// Some 1 +``` + +### Example 2 + +```fsharp +let opt = Option.ofNull null +// None +``` + diff --git a/gitbook/option/ofPair.md b/gitbook/option/ofPair.md new file mode 100644 index 00000000..24b5eb1e --- /dev/null +++ b/gitbook/option/ofPair.md @@ -0,0 +1,27 @@ +# Option.ofPair + +Namespace: `FsToolkit.ErrorHandling` + +Transforms a `bool * 'T` value to `'T Option`. + +## Function Signature + +```fsharp +bool * 'T -> 'T Option +``` + +## Examples + +### Example 1 + +```fsharp +let opt = Option.ofPair (true, 1) +// Some 1 +``` + +### Example 2 + +```fsharp +let opt = Option.ofPair (false, 1) +// None +``` diff --git a/gitbook/option/ofResult.md b/gitbook/option/ofResult.md new file mode 100644 index 00000000..bfd30471 --- /dev/null +++ b/gitbook/option/ofResult.md @@ -0,0 +1,28 @@ +# Option.ofResult + +Namespace: `FsToolkit.ErrorHandling` + +Transforms a `Result<'T, 'Error>` value to `'T Option`. + +## Function Signature + +```fsharp +Result<'T, 'Error> -> 'T Option +``` + +## Examples + +### Example 1 + +```fsharp +let opt = Option.ofResult (Ok 1) +// Some 1 +``` + +### Example 2 + +```fsharp +let opt = Option.ofResult (Error "error") +// None +``` + diff --git a/gitbook/option/ofValueOption.md b/gitbook/option/ofValueOption.md new file mode 100644 index 00000000..9af53918 --- /dev/null +++ b/gitbook/option/ofValueOption.md @@ -0,0 +1,30 @@ +# Option.ofValueOption + +Namespace: `FsToolkit.ErrorHandling` + +Transforms a `'T voption` value to `'T Option`. + +## Function Signature + +```fsharp +'T voption -> 'T Option +``` + +## Examples + +### Example 1 + +```fsharp +let x : int voption = Some 1 +let opt = Option.ofValueOption x +// Some 1 +``` + +### Example 2 + +```fsharp +let x : int voption = None +let opt = Option.ofValueOption x +// None +``` + diff --git a/gitbook/option/toValueOption.md b/gitbook/option/toValueOption.md new file mode 100644 index 00000000..e263e904 --- /dev/null +++ b/gitbook/option/toValueOption.md @@ -0,0 +1,28 @@ +# Option.toValueOption + +Namespace: `FsToolkit.ErrorHandling` + +Transforms a `'T Option` value to `'T voption`. + +## Function Signature + +```fsharp +'T Option -> 'T voption +``` + +## Examples + +### Example 1 + +```fsharp +let opt = Option.toValueOption (Some 1) +// Some 1 +``` + +### Example 2 + +```fsharp +let opt = Option.toValueOption None +// None +``` + diff --git a/gitbook/resultOption/ofChoice.md b/gitbook/resultOption/ofChoice.md new file mode 100644 index 00000000..7e5e0e8e --- /dev/null +++ b/gitbook/resultOption/ofChoice.md @@ -0,0 +1,28 @@ +# ResultOption.ofChoice + +Namespace: `FsToolkit.ErrorHandling` + +Transforms a `Choice<'T, 'Error>` value to `Result<'T option, 'Error>`. + +## Function Signature + +```fsharp +Choice<'T, 'Error> -> Result<'T option, 'Error> +``` + +## Examples + +### Example 1 + +```fsharp +let result = ResultOption.ofChoice (Choice1Of2 42) +// Ok (Some 42) +``` + +### Example 2 + +```fsharp +let result = ResultOption.ofChoice (Choice2Of2 "error") +// Error "error" +``` + diff --git a/gitbook/resultOption/ofOption.md b/gitbook/resultOption/ofOption.md new file mode 100644 index 00000000..88bbba4e --- /dev/null +++ b/gitbook/resultOption/ofOption.md @@ -0,0 +1,28 @@ +# ResultOption.ofOption + +Namespace: `FsToolkit.ErrorHandling` + +Transforms a `'T Option` value to `Result<'T option, 'Error>`. + +## Function Signature + +```fsharp +Result<'T, 'Error> -> Result<'T option, 'Error> +``` + +## Examples + +### Example 1 + +```fsharp +let result = ResultOption.ofOption (Some 42) +// Ok (Some 42) +``` + +### Example 2 + +```fsharp +let result = ResultOption.ofOption None +// Ok None +``` + diff --git a/gitbook/resultOption/ofResult.md b/gitbook/resultOption/ofResult.md new file mode 100644 index 00000000..1082fa01 --- /dev/null +++ b/gitbook/resultOption/ofResult.md @@ -0,0 +1,28 @@ +# ResultOption.ofResult + +Namespace: `FsToolkit.ErrorHandling` + +Transforms a `Result<'T, 'Error>` value to `Result<'T option, 'Error>`. + +## Function Signature + +```fsharp +Result<'T, 'Error> -> Result<'T option, 'Error> +``` + +## Examples + +### Example 1 + +```fsharp +let result = ResultOption.ofResult (Ok 42) +// Ok (Some 42) +``` + +### Example 2 + +```fsharp +let result = ResultOption.ofResult (Error "error") +// Error "error" +``` + diff --git a/gitbook/task/ofUnit.md b/gitbook/task/ofUnit.md new file mode 100644 index 00000000..4e0b302a --- /dev/null +++ b/gitbook/task/ofUnit.md @@ -0,0 +1,20 @@ +# Task.ofUnit + +Namespace: `FsToolkit.ErrorHandling` + +Transforms a `Task` into a `Task` + +## Function Signature + +```fsharp +Task -> Task +``` + +## Examples + +### Example 1 + +```fsharp +let result = Task.ofUnit (task { return () }) +// task { return () } +``` diff --git a/gitbook/taskResult/ofAsync.md b/gitbook/taskResult/ofAsync.md index 38f67da2..3c58baa1 100644 --- a/gitbook/taskResult/ofAsync.md +++ b/gitbook/taskResult/ofAsync.md @@ -1,12 +1,27 @@ -## TaskResult.ofAsync +# TaskResult.ofAsync Namespace: `FsToolkit.ErrorHandling` -Function Signature: +Transforms an `Async<'T>` into a `Task>`. + +## Function Signature ```fsharp -Async<'a> -> Task> +Async<'T> -> Task> ``` ## Examples +### Example 1 + +```fsharp +let result = TaskResult.ofAsync (async { return 42 }) +// task { return Ok 42 } +``` + +### Example 2 + +```fsharp +let result = TaskResult.ofAsync (async { return System.Exception("error") }) +// task { return Error (System.Exception("error")) } +``` diff --git a/gitbook/taskResult/ofResult.md b/gitbook/taskResult/ofResult.md new file mode 100644 index 00000000..c28ca071 --- /dev/null +++ b/gitbook/taskResult/ofResult.md @@ -0,0 +1,27 @@ +# TaskResult.ofResult + +Namespace: `FsToolkit.ErrorHandling` + +Transforms a `Result<'T, 'Error>` into a `Task>`. + +## Function Signature + +```fsharp +Result<'T, 'Error> -> Task> +``` + +## Examples + +### Example 1 + +```fsharp +let result = TaskResult.ofResult (Ok 42) +// task { return Ok 42 } +``` + +### Example 2 + +```fsharp +let result = TaskResult.ofResult (Error "error") +// task { return Error "error" } +``` diff --git a/gitbook/taskResult/ofTask.md b/gitbook/taskResult/ofTask.md new file mode 100644 index 00000000..961cf253 --- /dev/null +++ b/gitbook/taskResult/ofTask.md @@ -0,0 +1,27 @@ +# TaskResult.ofTask + +Namespace: `FsToolkit.ErrorHandling` + +Transforms a `Task<'T>` into a `Task>`. + +## Function Signature + +```fsharp +Task<'T> -> Task> +``` + +## Examples + +### Example 1 + +```fsharp +let result = TaskResult.ofTask (task { return 42 }) +// task { return Ok 42 } +``` + +### Example 2 + +```fsharp +let result = TaskResult.ofTask (task { return System.Exception("error") }) +// task { return Error (System.Exception("error")) } +``` diff --git a/gitbook/validation/ofChoice.md b/gitbook/validation/ofChoice.md new file mode 100644 index 00000000..e286b6da --- /dev/null +++ b/gitbook/validation/ofChoice.md @@ -0,0 +1,27 @@ +# Validation.ofChoice + +Namespace: `FsToolkit.ErrorHandling` + +Transforms a `Choice<'T, 'Error>` into a `Result<'T, 'Error list>` + +## Function Signature + +```fsharp +Choice<'T, 'Error> -> Result<'T, 'Error list> +``` + +## Examples + +### Example 1 + +```fsharp +let result = Validation.ofChoice (Choice1Of2 42) +// Ok 42 +``` + +### Example 2 + +```fsharp +let result = Validation.ofChoice (Choice2Of2 "error") +// Error ["error"] +``` diff --git a/gitbook/validation/ofResult.md b/gitbook/validation/ofResult.md index 1f53ac54..cfb9b805 100644 --- a/gitbook/validation/ofResult.md +++ b/gitbook/validation/ofResult.md @@ -1,13 +1,27 @@ -## Validation.ofResult +# Validation.ofResult Namespace: `FsToolkit.ErrorHandling` -Function Signature: +Transforms a `Result<'T, 'Error>` into a `Result<'T, 'Error list>` + +## Function Signature + +```fsharp +Result<'T, 'Error> -> Result<'T, 'Error list> +``` + +## Examples + +### Example 1 ```fsharp -Result<'a, 'b> -> Result<'a, 'b list> +let result = Validation.ofResult (Ok 42) +// Ok 42 ``` -Simply wraps the error in a list. +### Example 2 -## Examples \ No newline at end of file +```fsharp +let result = Validation.ofResult (Error "error") +// Error ["error"] +```