ReadableStreamBYOBReader: метод cancel()
Ограниченная доступность
Эта функция не является базовой, так как она не работает во всех наиболее широко используемых браузерах.
Примечание: Эта функция доступна в Web Workers.
Метод cancel() интерфейса ReadableStreamBYOBReader возвращает Promise, который выполняется, когда поток отменён. Вызов этого метода сигнализирует о потере интереса к потоку потребителем.
Примечание: Если читатель активен, метод cancel() ведет себя так же, как и для связанного потока (ReadableStream.cancel()).
Синтаксис
cancel() cancel(reason)
Параметры
reasonНеобязательно-
Описание причины отмены, понятное человеку. Источник может или не может его использовать.
Возвращаемое значение
A Promise, который выполняется со значением, заданным в параметре reason.
Исключения
TypeError-
Объект источника не является
ReadableStreamBYOBReader, или у потока нет владельца.
Примеры
В этом примере кода метод cancel() вызывается при нажатии кнопки, передавая строку "user choice" в качестве причины. Обещание выполняется при завершении отмены.
button.addEventListener("click", () => {
reader.cancel("user choice").then(() => console.log(`cancel complete`));
});
Обратите внимание, что этот код можно увидеть, работающий в примере кода Использование читаемых байтовых потоков (нажмите кнопку Отменить поток).
Спецификации
| Спецификация |
|---|
| Потоки # ref-for-generic-reader-cancel② |
Совместимость с браузерами
| Рабочие столы | Мобильные устройства | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Chrome | Edge | Firefox | Opera | Safari | Chrome Android | Firefox для Android | Opera Android | Safari на IOS | Samsung Internet | WebView Android | |
cancel |
89 | 89 | 102 | 75 | Нет | 89 | 102 | 63 | Нет | 15.0 | 89 |
См. также
© 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/ReadableStreamBYOBReader/cancel