Click or drag to resize

IAsyncCursorExtensionsFirstAsyncTDocument Method

Returns the first document of a cursor.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.15.0+f503bf610759c13f78cff9a3c01e91453185d2ed
Syntax
public static Task<TDocument> FirstAsync<TDocument>(
	this IAsyncCursor<TDocument> cursor,
	CancellationToken cancellationToken = default
)

Parameters

cursor
Type: MongoDB.DriverIAsyncCursorTDocument
The cursor.
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.

Usage Note

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