WritableStreamDefaultWriter: метод abort()

Примечание: Эта функция доступна в Web Workers.

Метод abort() интерфейса WritableStreamDefaultWriter прерывает поток, сигнализируя о том, что производитель больше не может успешно записывать в поток, и он немедленно переходит в состояние ошибки, при этом все очереди записей отбрасываются.

Если писатель активен, метод abort() ведет себя так же, как и для связанного потока (WritableStream.abort()). Если нет, он возвращает отклоненное обещание.

Синтаксис

abort()
abort(reason)

Параметры

reason Необязательно: Строка, представляющая удобочитаемое описание причины прерывания.

Возвращаемое значение

Обещание Promise, которое выполняется со значением undefined при прерывании потока или отклоняется с ошибкой, если писатель был неактивен или поток получателя недействителен.

Исключения

TypeError: Поток, который вы пытаетесь прервать, не является WritableStream, или он заблокирован.

Примеры

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

// ...

const writer = writableStream.getWriter();

// ...

// abort the stream when desired
await writer.abort("WritableStream aborted. Reason: ...");

Спецификации

Спецификация
Потоки # ref-for-default-writer-abort④

Совместимость с браузерами

	Рабочий стол					Мобильные устройства
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox для Android	Opera Android	Safari на iOS	Samsung Internet	WebView Android
`abort`	59	16	100	46	14.1	59	100	43	14.5	7.0	59

© 2005–2024 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/WritableStreamDefaultWriter/abort