MongoDB\ChangeStream::valid()

Definition

MongoDB\ChangeStream::valid()

Returns whether there is a current event in the change stream.

function valid(): boolean

When manually iterating the change stream using

Iteratormethods, this method should be used to determine ifMongoDB\ChangeStream::current() and MongoDB\ChangeStream::key() can be called.

Return Values

A boolean indicating whether there is a current event in the change stream.

See Also

• MongoDB\Client::watch()

• MongoDB\Collection::watch()

• MongoDB\Database::watch()

• Iterator::valid()

• Tailable Cursor Iteration

• Change Streams documentation in the MongoDB manual