Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

std/node/stream.ts>Readable#pause

Deno standard library
Go to Latest
The Standard Library has been moved to JSR. See the blog post for details.
method Readable.prototype.pause
import { Readable } from "https://deno.land/std@0.128.0/node/stream.ts";

The readable.pause() method will cause a stream in flowing mode to stop emitting 'data' events, switching out of flowing mode. Any data that becomes available will remain in the internal buffer.

const readable = getReadableStreamSomehow();
readable.on('data', (chunk) => {
  console.log(`Received ${chunk.length} bytes of data.`);
  readable.pause();
  console.log('There will be no additional data for 1 second.');
  setTimeout(() => {
    console.log('Now data will start flowing again.');
    readable.resume();
  }, 1000);
});

The readable.pause() method has no effect if there is a 'readable'event listener.