WritableStream.locked

Draft

This page is not complete.

Experimental

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

The locked read-only property of the WritableStream interface returns a boolean indicating whether the WritableStream is locked to a writer. 

Syntax

var locked = writableStream.locked;

Value

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

Examples

const writableStream = new WritableStream({
  write(chunk) {
    ...
  },
  close() {
    ...
  },
  abort(err) {
    ...
  }
}, queuingStrategy);

...

const writer = writableStream.getWriter();

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

Specifications

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

Browser compatibility

BCD tables only load in the browser