AsyncAwaitBestPractices.MVVM
8.0.0
dotnet add package AsyncAwaitBestPractices.MVVM --version 8.0.0
NuGet\Install-Package AsyncAwaitBestPractices.MVVM -Version 8.0.0
<PackageReference Include="AsyncAwaitBestPractices.MVVM" Version="8.0.0" />
paket add AsyncAwaitBestPractices.MVVM --version 8.0.0
#r "nuget: AsyncAwaitBestPractices.MVVM, 8.0.0"
// Install AsyncAwaitBestPractices.MVVM as a Cake Addin #addin nuget:?package=AsyncAwaitBestPractices.MVVM&version=8.0.0 // Install AsyncAwaitBestPractices.MVVM as a Cake Tool #tool nuget:?package=AsyncAwaitBestPractices.MVVM&version=8.0.0
AsyncAwaitBestPractices.MVVM
Available on NuGet: https://www.nuget.org/packages/AsyncAwaitBestPractices.MVVM/
Allows for
Task
to safely be used asynchronously withICommand
:IAsyncCommand : ICommand
AsyncCommand : IAsyncCommand
IAsyncCommand<T> : ICommand
AsyncCommand<T> : IAsyncCommand<T>
IAsyncCommand<TExecute, TCanExecute> : IAsyncCommand<TExecute>
AsyncCommand<TExecute, TCanExecute> : IAsyncCommand<TExecute, TCanExecute>
Allows for
ValueTask
to safely be used asynchronously withICommand
:IAsyncValueCommand : ICommand
AsyncValueCommand : IAsyncValueCommand
IAsyncValueCommand<T> : ICommand
AsyncValueCommand<T> : IAsyncValueCommand<T>
IAsyncValueCommand<TExecute, TCanExecute> : IAsyncValueCommand<TExecute>
AsyncValueCommand<TExecute, TCanExecute> : IAsyncValueCommand<TExecute, TCanExecute>
Setup
- Available on NuGet: https://www.nuget.org/packages/AsyncAwaitBestPractices.MVVM/
- Add to any project supporting .NET Standard 1.0
AsyncCommand
Allows for Task
to safely be used asynchronously with ICommand
:
AsyncCommand<TExecute, TCanExecute> : IAsyncCommand<TExecute, TCanExecute>
IAsyncCommand<TExecute, TCanExecute> : IAsyncCommand<TExecute>
AsyncCommand<T> : IAsyncCommand<T>
IAsyncCommand<T> : ICommand
AsyncCommand : IAsyncCommand
IAsyncCommand : ICommand
public AsyncCommand(Func<TExecute, Task> execute,
Func<TCanExecute, bool>? canExecute = null,
Action<Exception>? onException = null,
bool continueOnCapturedContext = false)
public AsyncCommand(Func<T, Task> execute,
Func<object?, bool>? canExecute = null,
Action<Exception>? onException = null,
bool continueOnCapturedContext = false)
public AsyncCommand(Func<Task> execute,
Func<object?, bool>? canExecute = null,
Action<Exception>? onException = null,
bool continueOnCapturedContext = false)
public class ExampleClass
{
bool _isBusy;
public ExampleClass()
{
ExampleAsyncCommand = new AsyncCommand(ExampleAsyncMethod);
ExampleAsyncIntCommand = new AsyncCommand<int>(ExampleAsyncMethodWithIntParameter);
ExampleAsyncIntCommandWithCanExecute = new AsyncCommand<int, int>(ExampleAsyncMethodWithIntParameter, CanExecuteInt);
ExampleAsyncExceptionCommand = new AsyncCommand(ExampleAsyncMethodWithException, onException: ex => Console.WriteLine(ex.ToString()));
ExampleAsyncCommandWithCanExecuteChanged = new AsyncCommand(ExampleAsyncMethod, _ => !IsBusy);
ExampleAsyncCommandReturningToTheCallingThread = new AsyncCommand(ExampleAsyncMethod, continueOnCapturedContext: true);
}
public IAsyncCommand ExampleAsyncCommand { get; }
public IAsyncCommand<int> ExampleAsyncIntCommand { get; }
public IAsyncCommand<int, int> ExampleAsyncIntCommandWithCanExecute { get; }
public IAsyncCommand ExampleAsyncExceptionCommand { get; }
public IAsyncCommand ExampleAsyncCommandWithCanExecuteChanged { get; }
public IAsyncCommand ExampleAsyncCommandReturningToTheCallingThread { get; }
public bool IsBusy
{
get => _isBusy;
set
{
if (_isBusy != value)
{
_isBusy = value;
ExampleAsyncCommandWithCanExecuteChanged.RaiseCanExecuteChanged();
}
}
}
async Task ExampleAsyncMethod()
{
await Task.Delay(1000);
}
async Task ExampleAsyncMethodWithIntParameter(int parameter)
{
await Task.Delay(parameter);
}
async Task ExampleAsyncMethodWithException()
{
await Task.Delay(1000);
throw new Exception();
}
bool CanExecuteInt(int count)
{
if(count > 2)
return true;
return false;
}
void ExecuteCommands()
{
_isBusy = true;
try
{
ExampleAsyncCommand.Execute(null);
ExampleAsyncIntCommand.Execute(1000);
ExampleAsyncExceptionCommand.Execute(null);
ExampleAsyncCommandReturningToTheCallingThread.Execute(null);
if(ExampleAsyncCommandWithCanExecuteChanged.CanExecute(null))
ExampleAsyncCommandWithCanExecuteChanged.Execute(null);
if(ExampleAsyncIntCommandWithCanExecute.CanExecute(1))
ExampleAsyncIntCommandWithCanExecute.Execute(1);
}
finally
{
_isBusy = false;
}
}
}
AsyncValueCommand
Allows for ValueTask
to safely be used asynchronously with ICommand
.
If you're new to ValueTask, check out this great write-up, Understanding the Whys, Whats, and Whens of ValueTask.
AsyncValueCommand<TExecute, TCanExecute> : IAsyncValueCommand<TExecute, TCanExecute>
IAsyncValueCommand<TExecute, TCanExecute> : IAsyncValueCommand<TExecute>
AsyncValueCommand<T> : IAsyncValueCommand<T>
IAsyncValueCommand<T> : ICommand
AsyncValueCommand : IAsyncValueCommand
IAsyncValueCommand : ICommand
public AsyncValueCommand(Func<TExecute, ValueTask> execute,
Func<TCanExecute, bool>? canExecute = null,
Action<Exception>? onException = null,
bool continueOnCapturedContext = false)
public AsyncValueCommand(Func<T, ValueTask> execute,
Func<object?, bool>? canExecute = null,
Action<Exception>? onException = null,
bool continueOnCapturedContext = false)
public AsyncValueCommand(Func<ValueTask> execute,
Func<object?, bool>? canExecute = null,
Action<Exception>? onException = null,
bool continueOnCapturedContext = false)
public class ExampleClass
{
bool _isBusy;
public ExampleClass()
{
ExampleValueTaskCommand = new AsyncValueCommand(ExampleValueTaskMethod);
ExampleValueTaskIntCommand = new AsyncValueCommand<int>(ExampleValueTaskMethodWithIntParameter);
ExampleValueTaskIntCommandWithCanExecute = new AsyncValueCommand<int, int>(ExampleValueTaskMethodWithIntParameter, CanExecuteInt);
ExampleValueTaskExceptionCommand = new AsyncValueCommand(ExampleValueTaskMethodWithException, onException: ex => Debug.WriteLine(ex.ToString()));
ExampleValueTaskCommandWithCanExecuteChanged = new AsyncValueCommand(ExampleValueTaskMethod, _ => !IsBusy);
ExampleValueTaskCommandReturningToTheCallingThread = new AsyncValueCommand(ExampleValueTaskMethod, continueOnCapturedContext: true);
}
public IAsyncValueCommand ExampleValueTaskCommand { get; }
public IAsyncValueCommand<int> ExampleValueTaskIntCommand { get; }
public IAsyncCommand<int, int> ExampleValueTaskIntCommandWithCanExecute { get; }
public IAsyncValueCommand ExampleValueTaskExceptionCommand { get; }
public IAsyncValueCommand ExampleValueTaskCommandWithCanExecuteChanged { get; }
public IAsyncValueCommand ExampleValueTaskCommandReturningToTheCallingThread { get; }
public bool IsBusy
{
get => _isBusy;
set
{
if (_isBusy != value)
{
_isBusy = value;
ExampleValueTaskCommandWithCanExecuteChanged.RaiseCanExecuteChanged();
}
}
}
async ValueTask ExampleValueTaskMethod()
{
var random = new Random();
if (random.Next(10) > 9)
await Task.Delay(1000);
}
async ValueTask ExampleValueTaskMethodWithIntParameter(int parameter)
{
var random = new Random();
if (random.Next(10) > 9)
await Task.Delay(parameter);
}
async ValueTask ExampleValueTaskMethodWithException()
{
var random = new Random();
if (random.Next(10) > 9)
await Task.Delay(1000);
throw new Exception();
}
bool CanExecuteInt(int count)
{
if(count > 2)
return true;
return false;
}
void ExecuteCommands()
{
_isBusy = true;
try
{
ExampleValueTaskCommand.Execute(null);
ExampleValueTaskIntCommand.Execute(1000);
ExampleValueTaskExceptionCommand.Execute(null);
ExampleValueTaskCommandReturningToTheCallingThread.Execute(null);
if (ExampleValueTaskCommandWithCanExecuteChanged.CanExecute(null))
ExampleValueTaskCommandWithCanExecuteChanged.Execute(null);
if(ExampleValueTaskIntCommandWithCanExecute.CanExecute(2))
ExampleValueTaskIntCommandWithCanExecute.Execute(2);
}
finally
{
_isBusy = false;
}
}
}
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. 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 is compatible. 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 is compatible. 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. |
.NET Core | netcoreapp1.0 was computed. netcoreapp1.1 was computed. netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard1.0 is compatible. netstandard1.1 was computed. netstandard1.2 was computed. netstandard1.3 was computed. netstandard1.4 was computed. netstandard1.5 was computed. netstandard1.6 was computed. netstandard2.0 is compatible. netstandard2.1 is compatible. |
.NET Framework | net45 was computed. net451 was computed. net452 was computed. net46 was computed. 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 | tizen30 was computed. tizen40 was computed. tizen60 was computed. |
Universal Windows Platform | uap was computed. uap10.0 was computed. |
Windows Phone | wp8 was computed. wp81 was computed. wpa81 was computed. |
Windows Store | netcore was computed. netcore45 was computed. netcore451 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 1.0
- AsyncAwaitBestPractices (>= 8.0.0)
-
.NETStandard 2.0
- AsyncAwaitBestPractices (>= 8.0.0)
-
.NETStandard 2.1
- AsyncAwaitBestPractices (>= 8.0.0)
-
net6.0
- AsyncAwaitBestPractices (>= 8.0.0)
-
net7.0
- AsyncAwaitBestPractices (>= 8.0.0)
-
net8.0
- AsyncAwaitBestPractices (>= 8.0.0)
NuGet packages (7)
Showing the top 5 NuGet packages that depend on AsyncAwaitBestPractices.MVVM:
Package | Downloads |
---|---|
AwaitablePopups
Create your own DisplayAlerts using XAML, or use the DisplayAlerts,LoaderDialogs and LoginViews that's included! Powered by AsyncAwaitBestPractices and Rg.Plugins.Popup |
|
GuardedActions
Package Description |
|
AppHosting.Xamarin.Forms
Provides attributes, controls, extensions methods, Xamarin.Forms page & element middlewares, services & utilities to setup your application infrastructure. Please, head to the project's repository for wiki. |
|
Sanet.MVVM.Core
A simple MVVM helpers library to support my personal legacy projects |
|
Mopups.PreBaked
Transition Package for AwaitablePopups to use Mopups and Maui This package contains pre-built Popups for use in MAUI, see https://github.com/LuckyDucko/AwaitablePopups |
GitHub repositories (9)
Showing the top 5 popular GitHub repositories that depend on AsyncAwaitBestPractices.MVVM:
Repository | Stars |
---|---|
beeradmoore/dlss-swapper
|
|
yourtablecloth/TableCloth
식탁보 프로젝트
|
|
fernandreu/office-ribbonx-editor
An overhauled fork of the original Custom UI Editor for Microsoft Office, built with WPF
|
|
BAndysc/WoWDatabaseEditor
Integrated development environment (IDE), an editor for Smart Scripts (SAI/smart_scripts) for TrinityCore based servers. Cmangos support work in progress. Featuring a 3D view built with OpenGL and custom ECS framework
|
|
davidortinau/Xappy
A mobile app to track Xamarin news and explore all the goodness that is .NET for Mobile developers
|
Version | Downloads | Last updated |
---|---|---|
8.0.0 | 3,638 | 7/9/2024 |
7.0.0 | 28,330 | 11/14/2023 |
6.0.6 | 112,528 | 11/12/2022 |
6.0.5 | 14,909 | 7/3/2022 |
6.0.4 | 105,725 | 11/23/2021 |
6.0.3 | 5,390 | 11/11/2021 |
6.0.2 | 11,389 | 10/12/2021 |
6.0.1 | 8,968 | 9/27/2021 |
6.0.0 | 28,991 | 7/3/2021 |
6.0.0-pre1 | 1,194 | 6/7/2021 |
5.1.0 | 63,261 | 3/13/2021 |
5.0.2 | 107,106 | 11/2/2020 |
5.0.0-pre2 | 2,001 | 9/17/2020 |
5.0.0-pre1 | 915 | 9/17/2020 |
4.3.0 | 12,572 | 9/15/2020 |
4.3.0-pre1 | 2,053 | 7/29/2020 |
4.2.0 | 22,151 | 7/13/2020 |
4.1.1 | 30,155 | 5/15/2020 |
4.1.1-pre1 | 2,495 | 4/1/2020 |
4.1.0 | 57,158 | 1/30/2020 |
4.1.0-pre2 | 1,430 | 1/7/2020 |
4.1.0-pre1 | 1,384 | 12/19/2019 |
4.0.1 | 11,065 | 12/13/2019 |
4.0.0-pre3 | 1,178 | 11/29/2019 |
4.0.0-pre1 | 987 | 11/7/2019 |
3.1.0 | 19,341 | 8/28/2019 |
3.1.0-pre5 | 1,202 | 8/20/2019 |
3.1.0-pre4 | 1,001 | 8/20/2019 |
3.1.0-pre3 | 1,069 | 8/14/2019 |
3.1.0-pre2 | 1,175 | 7/31/2019 |
3.1.0-pre1 | 951 | 7/31/2019 |
3.0.0 | 3,079 | 7/30/2019 |
3.0.0-pre4 | 1,073 | 7/14/2019 |
3.0.0-pre3 | 1,026 | 7/7/2019 |
3.0.0-pre2 | 1,075 | 7/2/2019 |
3.0.0-pre1 | 1,079 | 6/9/2019 |
2.1.1 | 11,987 | 4/17/2019 |
2.1.0 | 3,940 | 1/12/2019 |
2.1.0-pre1 | 1,406 | 12/27/2018 |
2.0.0 | 1,410 | 12/19/2018 |
1.2.1 | 1,334 | 12/17/2018 |
1.1.0 | 1,312 | 12/16/2018 |
1.0.1 | 1,348 | 12/15/2018 |
1.0.0 | 1,533 | 11/30/2018 |
0.9.0 | 1,703 | 11/22/2018 |
New in this release:
- Target AsyncAwaitBestPractices v8.0.0
- Add Support for ValueTask<T>