Click or drag to resize

IAsyncCursorSourceExtensionsFirstOrDefaultAsyncTDocument Method

Returns the first document of a cursor returned by a cursor source, or a default value if the cursor contains no documents.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.19.1+3a2a09dd959482f665ffbb5df2557ec541597af4
Syntax
public static Task<TDocument> FirstOrDefaultAsync<TDocument>(
	this IAsyncCursorSource<TDocument> source,
	CancellationToken cancellationToken = default
)

Parameters

source
Type: MongoDB.DriverIAsyncCursorSourceTDocument
The source.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
The cancellation token.

Type Parameters

TDocument
The type of the document.

Return Value

Type: TaskTDocument
A Task whose result is the first document of the cursor, or a default value if the cursor contains no documents.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IAsyncCursorSourceTDocument. 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