VOOZH about

URL: https://www.nuget.org/packages/Optional.Async/

⇱ NuGet Gallery | Optional.Async 1.3.0




Optional.Async 1.3.0

dotnet add package Optional.Async --version 1.3.0
 
 
NuGet\Install-Package Optional.Async -Version 1.3.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="Optional.Async" Version="1.3.0" />
 
 
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Optional.Async" Version="1.3.0" />
 
Directory.Packages.props
<PackageReference Include="Optional.Async" />
 
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 Optional.Async --version 1.3.0
 
 
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Optional.Async, 1.3.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.
#:package Optional.Async@1.3.0
 
 
#: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=Optional.Async&version=1.3.0
 
Install as a Cake Addin
#tool nuget:?package=Optional.Async&version=1.3.0
 
Install as a Cake Tool
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Optional.Async

Async extensions for Nils Luck's Optional library.

It allows you to chain Task<Option<T>> and Task<Option<T, TException>> without having to use await.

Since version 5.0, the Optional library will include its own async extensions. However, at this point they don't provide as much flexibility. To avoid conflicts, the namespace of this library has been changed to Optional.Async.Extensions.

Note: Optional.Async was not meant to be published as a standalone library. It's a collection of extension methods that I had to implement on my own while working with Optional. There are currently no tests and I don't plan on extensively maintaining it. Still, most of the extensions you'll find here are currently being used/have been used for the past year in production code without issues.

Usage


Say you have the following asynchronous functions and you want to execute them in order:

Task<Option<User, Error>> CheckIfUserIsAuthorized(string userId, string category);

Task<Option<CloudRecord, Error>> StoreTheFileIntoTheCloud(File file, string category);

Task<Option<Guid, Error>> StoreDatabaseLog(CloudRecord record);

Task<Option<DocumentProcessedResult, Error>> SendToExternalService(Guid key);

Currently, there is no built-in mechanism inside Optional that allows you to chain these calls. What Optional.Async provides is the ability to compose asynchronous functions. The following would be valid syntax:

Task<Option<DocumentProcessedResult, Error>> ProcessDocument(
 string userId,
 string category,
 File file) =>
 CheckIfUserIsAuthorized(userId, category).FlatMapAsync(user =>
 StoreTheFileIntoTheCloud(file, category).FlatMapAsync(cloudRecord =>
 StoreDatabaseLog(cloudRecord).FlatMapAsync(uniqueKey =>
 SendToExternalService(uniqueKey))));

See the DevAdventures RealWorld project and the DDD Café for more examples.

Product Versions Compatible and additional computed target framework versions.
.NET net5.0 net5.0 was computed.  net5.0-windows net5.0-windows was computed.  net6.0 net6.0 was computed.  net6.0-android net6.0-android was computed.  net6.0-ios net6.0-ios was computed.  net6.0-maccatalyst net6.0-maccatalyst was computed.  net6.0-macos net6.0-macos was computed.  net6.0-tvos net6.0-tvos was computed.  net6.0-windows net6.0-windows was computed.  net7.0 net7.0 was computed.  net7.0-android net7.0-android was computed.  net7.0-ios net7.0-ios was computed.  net7.0-maccatalyst net7.0-maccatalyst was computed.  net7.0-macos net7.0-macos was computed.  net7.0-tvos net7.0-tvos was computed.  net7.0-windows net7.0-windows was computed.  net8.0 net8.0 was computed.  net8.0-android net8.0-android was computed.  net8.0-browser net8.0-browser was computed.  net8.0-ios net8.0-ios was computed.  net8.0-maccatalyst net8.0-maccatalyst was computed.  net8.0-macos net8.0-macos was computed.  net8.0-tvos net8.0-tvos was computed.  net8.0-windows net8.0-windows was computed.  net9.0 net9.0 was computed.  net9.0-android net9.0-android was computed.  net9.0-browser net9.0-browser was computed.  net9.0-ios net9.0-ios was computed.  net9.0-maccatalyst net9.0-maccatalyst was computed.  net9.0-macos net9.0-macos was computed.  net9.0-tvos net9.0-tvos was computed.  net9.0-windows net9.0-windows was computed.  net10.0 net10.0 was computed.  net10.0-android net10.0-android was computed.  net10.0-browser net10.0-browser was computed.  net10.0-ios net10.0-ios was computed.  net10.0-maccatalyst net10.0-maccatalyst was computed.  net10.0-macos net10.0-macos was computed.  net10.0-tvos net10.0-tvos was computed.  net10.0-windows net10.0-windows was computed. 
.NET Core netcoreapp2.0 netcoreapp2.0 was computed.  netcoreapp2.1 netcoreapp2.1 was computed.  netcoreapp2.2 netcoreapp2.2 was computed.  netcoreapp3.0 netcoreapp3.0 was computed.  netcoreapp3.1 netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 netstandard2.0 is compatible.  netstandard2.1 netstandard2.1 was computed. 
.NET Framework net461 net461 was computed.  net462 net462 was computed.  net463 net463 was computed.  net47 net47 was computed.  net471 net471 was computed.  net472 net472 was computed.  net48 net48 was computed.  net481 net481 was computed. 
MonoAndroid monoandroid monoandroid was computed. 
MonoMac monomac monomac was computed. 
MonoTouch monotouch monotouch was computed. 
Tizen tizen40 tizen40 was computed.  tizen60 tizen60 was computed. 
Xamarin.iOS xamarinios xamarinios was computed. 
Xamarin.Mac xamarinmac xamarinmac was computed. 
Xamarin.TVOS xamarintvos xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (3)

Showing the top 3 NuGet packages that depend on Optional.Async:

Package Downloads
Apizr.Integrations.Optional

Refit based web api client management, but resilient (retry, connectivity, cache, auth, log, priority...)

YngStrs.Common.Cqrs

Provides base commands, queries and handlers.

JITDispatcher

A brief description of your package.

GitHub repositories (2)

Showing the top 2 popular GitHub repositories that depend on Optional.Async:

Repository Stars
Respawnsive/Apizr
Refit based web api client management, but resilient (retry, connectivity, cache, auth, log, priority, etc...)
dnikolovv/dev-adventures-realworld
A RealWorld application implemented using the Dev Adventures .NET Core template and functional programming.
Version Downloads Last Updated
1.3.0 1,058,714 6/19/2019
1.2.0 4,495 2/8/2019
1.1.0 4,432 11/26/2018
1.0.0 2,337 11/23/2018