getReader method

The getReader method creates a stream reader and locks the stream to the new reader.

Syntax

var retval = ReadableStream.getReader();

Parameters

This method has no parameters.

Return value

Type: ReadableStreamReader

If the ReadableStream object isn't locked, a ReadableStreamReader is returned. If the ReadableStream object is locked, an exception will be thrown.

Standards information

Remarks

When a stream is closed or errors, any reader it is locked to is released.

If the getReader method is called on an already locked stream, an exception will be thrown.

var reader1 = stream1.getReader(); // fine
var reader2 = stream1.getReader(); // exception thrown.

See also

ReadableStream