ReadableStream.locked

Draft
This page is not complete.

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The locked getter property of the ReadableStream interface returns whether or not the readable stream is locked to a reader.

Syntax

var locked = readableStreamInstance.locked;

Value

A Boolean indicating whether or not the readable stream is locked.

Examples

const stream = new ReadableStream({
  ...
});

const reader = stream.getReader();

stream.locked
// should return true, as the stream has been locked to a reader

Specifications

Specification Status Comment
Streams
The definition of 'locked' in that specification.
Living Standard Initial definition.

Browser compatibility

No compatibility data found. Please contribute data for "path.to.feature.NameOfTheProperty" (depth: 1) to the MDN compatibility data repository.

Document Tags and Contributors

 Contributors to this page: chrisdavidmills
 Last updated by: chrisdavidmills,