MongoQueryableFirstOrDefaultAsyncTSource Method (IMongoQueryableTSource, CancellationToken) |
Returns the first element of a sequence, or a default value if the sequence contains no elements.
Namespace:
MongoDB.Driver.Linq
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.19.1+3a2a09dd959482f665ffbb5df2557ec541597af4
Syntax public static Task<TSource> FirstOrDefaultAsync<TSource>(
this IMongoQueryable<TSource> source,
CancellationToken cancellationToken = default
)
<ExtensionAttribute>
Public Shared Function FirstOrDefaultAsync(Of TSource) (
source As IMongoQueryable(Of TSource),
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of TSource)
[<ExtensionAttribute>]
static member FirstOrDefaultAsync :
source : IMongoQueryable<'TSource> *
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<'TSource>
Parameters
- source
- Type: MongoDB.Driver.LinqIMongoQueryableTSource
The IMongoQueryableT to return the first element of. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Type Parameters
- TSource
- The type of the elements of source.
Return Value
Type:
TaskTSource
default(
TSource) if
source is empty; otherwise, the first element in
source.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
IMongoQueryableTSource. When you use instance method syntax to call this method, omit the first parameter. For more information, see
Extension Methods (Visual Basic) or
Extension Methods (C# Programming Guide).
See Also