Sequence.return()method

return(value?: R | undefined | PromiseLike<R | undefined>): Promise<IteratorResult<T, R | undefined>>

Finish iteration and optionally provide the iterator's final return value.

  • Mirrors the default async generator return() behaviour.
  • Subclasses can override this to perform cleanup before the sequence stops.