Skip to main content

send

Note

This is a point-in-time snapshot of the API documentation from January 2026. Going forward, we will not be maintaining a public copy of these references, and recommend users to refer to the built-in signature helpers available in the Hack LSP instead for complete and up-to-date information.

Send a value to the async generator and resumes execution of the generator

public function send(
  ?Ts $value,
): Awaitable<?(Tk, Tv)>;

You should always await the returned Awaitable to get the actual key/value tuple.

If null is returned, that means you have reached the end of iteration.

You cannot call send() without having the value returned from a previous call to send(), next(), raise(), having first awaited.

If you pass null to send(), that is equivalent to calling next(), but you still need an initial next() call before calling send(null).

Parameters​

  • ?Ts $value

Returns​

  • Awaitable<?(Tk,Tv)> - The Awaitable that produced the yielded key/value tuple in the generator. What is returned is a tuple or null.