dotnet / dotnet/dotnet-api-docs
It is not explained, what the `bool` that is returned by `WaitForNextTickAsync` indicates.
Open
area-System.Threading
Pri3
untriaged
- Dominant language
- C#
- Stars
- 949
- Forks
- 1.7k
- Avg merge
- 3d 27m
- Merged PRs (30d)
- 49
Description
### Type of issue
Missing information
### Description
Hey!
I'm using this timer to have a built in async timer, and would like to know what the `bool` returned by `WaitForNextTickAsync()` is doing. Is it false if it was cancelled or true if not? It's not stated anywhere.
### Page URL
https://learn.microsoft.com/en-us/dotnet/api/system.threading.periodictimer.waitfornexttickasync?view=net-8.0
### Content source URL
https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Threading/PeriodicTimer.xml
### Document Version Independent Id
0ef31de4-0c6b-4ae5-b172-c2e89beee4cc
### Article author
@dotnet-bot
Contributor guide
Assessment
This issue has not been assessed yet.