stream/web

Использование в Deno

import * as mod from "node:stream/web";

интерфейс ByteLengthQueuingStrategy

расширяет QueuingStrategy<ArrayBufferView>

Использование в Deno

import { type ByteLengthQueuingStrategy } from "node:stream/web";

Этот интерфейс Streams API предоставляет встроенную стратегию очереди по длине в байтах, которую можно использовать при создании потоков.

Свойства

highWaterMark: number

только для чтения

size: QueuingStrategySize<ArrayBufferView>

только для чтения

переменная ByteLengthQueuingStrategy

Свойства

prototype: ByteLengthQueuingStrategy

Класс ByteLengthQueuingStrategy является глобальной ссылкой на import { ByteLengthQueuingStrategy } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-bytelengthqueuingstrategy

Тип

globalThis extends { onmessage: any; ByteLengthQueuingStrategy: infer T; } ? T : stream/web

интерфейс CompressionStream

Использование в Deno

import { type CompressionStream } from "node:stream/web";

Свойства

readable: ReadableStream

только для чтения

writable: WritableStream

только для чтения

переменная CompressionStream

Свойства

prototype: CompressionStream

Класс CompressionStream является глобальной ссылкой на import { CompressionStream } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-compressionstream

Тип

globalThis extends { onmessage: any; ReportingObserver: any; CompressionStream: infer T;  } ? T : globalThis extends { onmessage: any; TransformStream: { prototype: infer T;  };  } ? { prototype: T;  } : stream/web

интерфейс CountQueuingStrategy

расширяет QueuingStrategy

Использование в Deno

import { type CountQueuingStrategy } from "node:stream/web";

Свойства

highWaterMark: number

только для чтения

size: QueuingStrategySize

только для чтения

переменная CountQueuingStrategy

Свойства

prototype: CountQueuingStrategy

Класс CountQueuingStrategy является глобальной ссылкой на import { CountQueuingStrategy } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-countqueuingstrategy

Тип

globalThis extends { onmessage: any; CountQueuingStrategy: infer T; } ? T : stream/web

интерфейс DecompressionStream

Использование в Deno

import { type DecompressionStream } from "node:stream/web";

Свойства

writable: WritableStream

только для чтения

readable: ReadableStream

только для чтения

переменная DecompressionStream

Свойства

prototype: DecompressionStream

Класс DecompressionStream является глобальной ссылкой на import { DecompressionStream } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-decompressionstream

Тип

globalThis extends { onmessage: any; ReportingObserver: any; DecompressionStream: infer T extends object;  } ? T : globalThis extends { onmessage: any; TransformStream: { prototype: infer T;  };  } ? { prototype: T;  } : stream/web

интерфейс QueuingStrategy

Использование в Deno

import { type QueuingStrategy } from "node:stream/web";

Параметры типа

T = any

Свойства

highWaterMark: number

необязательный

size: QueuingStrategySize<T>

необязательный

интерфейс QueuingStrategyInit

Использование в Deno

import { type QueuingStrategyInit } from "node:stream/web";

Свойства

highWaterMark: number

Создаёт новый ByteLengthQueuingStrategy с указанным верхним пределом очереди.

Обратите внимание, что указанный верхний предел очереди не проверяется заранее. Если он отрицательный, равен NaN или не является числом, соответствующий конструктор потока вызовет исключение при создании ByteLengthQueuingStrategy.

интерфейс QueuingStrategySize

Использование в Deno

import { type QueuingStrategySize } from "node:stream/web";

Параметры типа

T = any

Сигнатуры вызова

(chunk?: T): number

интерфейс ReadableByteStreamController

Использование в Deno

import { type ReadableByteStreamController } from "node:stream/web";

Свойства

byobRequest: undefined

только для чтения

desiredSize: number | null

только для чтения

Методы

close(): void

enqueue(chunk: ArrayBufferView): void

error(error?: any): void

переменная ReadableByteStreamController

Свойства

prototype: ReadableByteStreamController

Класс ReadableByteStreamController является глобальной ссылкой на import { ReadableByteStreamController } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-readablebytestreamcontroller

Тип

globalThis extends { onmessage: any; ReadableByteStreamController: infer T; } ? T : stream/web

интерфейс ReadableByteStreamControllerCallback

Использование в Deno

import { type ReadableByteStreamControllerCallback } from "node:stream/web";

Сигнатуры вызова

(controller: ReadableByteStreamController): void | PromiseLike<void>

интерфейс ReadableStream

Использование в Deno

import { type ReadableStream } from "node:stream/web";

Этот интерфейс Streams API представляет поток читаемых байтовых данных.

Параметры типа

R = any

Свойства

locked: boolean

только для чтения

Методы

cancel(reason?: any): Promise<void>

getReader(options: { mode: "byob"; }): ReadableStreamBYOBReader

getReader(): ReadableStreamDefaultReader<R>

getReader(options?: ReadableStreamGetReaderOptions): ReadableStreamReader<R>

pipeThrough<T>(

transform: ReadableWritablePair<T, R>,

options?: StreamPipeOptions,
): ReadableStream<T>

pipeTo(

destination: WritableStream<R>,

options?: StreamPipeOptions,
): Promise<void>

tee(): [ReadableStream<R>, ReadableStream<R>]

values(options?: { preventCancel?: boolean; }): ReadableStreamAsyncIterator<R>

[[Symbol.asyncIterator]](): ReadableStreamAsyncIterator<R>

Параметры типа

R = any

переменная ReadableStream

Свойства

prototype: ReadableStream

Методы

from<T>(iterable: Iterable<T> | AsyncIterable<T>): ReadableStream<T>

Класс ReadableStream является глобальной ссылкой на import { ReadableStream } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-readablestream

Тип

globalThis extends { onmessage: any; ReadableStream: infer T; } ? T : stream/web

интерфейс ReadableStreamAsyncIterator

расширяет [NodeJS.AsyncIterator]<T, BuiltinIteratorReturn, unknown>

Использование в Deno

import { type ReadableStreamAsyncIterator } from "node:stream/web";

Параметры типа

T

Методы

[[Symbol.asyncIterator]](): ReadableStreamAsyncIterator<T>

интерфейс ReadableStreamBYOBReader

расширяет ReadableStreamGenericReader

Использование в Deno

import { type ReadableStreamBYOBReader } from "node:stream/web";

Справочник MDN

Методы

read<T extends ArrayBufferView>(

view: T,

options?: { min?: number;  },
): Promise<ReadableStreamReadResult<T>>

Справочник MDN

releaseLock(): void

Справочник MDN

переменная ReadableStreamBYOBReader

Свойства

prototype: ReadableStreamBYOBReader

Класс ReadableStreamBYOBReader является глобальной ссылкой на import { ReadableStreamBYOBReader } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-readablestreambyobreader

Тип

globalThis extends { onmessage: any; ReadableStreamBYOBReader: infer T; } ? T : stream/web

интерфейс ReadableStreamBYOBRequest

Использование в Deno

import { type ReadableStreamBYOBRequest } from "node:stream/web";

Справочник MDN

Свойства

view: ArrayBufferView | null

только для чтения

Справочник MDN

Методы

respond(bytesWritten: number): void

Справочник MDN

respondWithNewView(view: ArrayBufferView): void

Справочник MDN

переменная ReadableStreamBYOBRequest

Свойства

prototype: ReadableStreamBYOBRequest

Класс ReadableStreamBYOBRequest является глобальной ссылкой на import { ReadableStreamBYOBRequest } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-readablestreambyobrequest

Тип

globalThis extends { onmessage: any; ReadableStreamBYOBRequest: infer T; } ? T : stream/web

интерфейс ReadableStreamDefaultController

Использование в Deno

import { type ReadableStreamDefaultController } from "node:stream/web";

Параметры типа

R = any

Свойства

desiredSize: number | null

только для чтения

Методы

close(): void

enqueue(chunk?: R): void

error(e?: any): void

Параметры типа

R = any

переменная ReadableStreamDefaultController

Свойства

prototype: ReadableStreamDefaultController

Класс ReadableStreamDefaultController является глобальной ссылкой на import { ReadableStreamDefaultController } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-readablestreamdefaultcontroller

Тип

globalThis extends { onmessage: any; ReadableStreamDefaultController: infer T; } ? T : stream/web

интерфейс ReadableStreamDefaultReader

расширяет ReadableStreamGenericReader

Использование в Deno

import { type ReadableStreamDefaultReader } from "node:stream/web";

Параметры типа

R = any

Методы

read(): Promise<ReadableStreamReadResult<R>>

releaseLock(): void

Параметры типа

R = any

переменная ReadableStreamDefaultReader

Свойства

prototype: ReadableStreamDefaultReader

Класс ReadableStreamDefaultReader является глобальной ссылкой на import { ReadableStreamDefaultReader } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-readablestreamdefaultreader

Тип

globalThis extends { onmessage: any; ReadableStreamDefaultReader: infer T; } ? T : stream/web

интерфейс ReadableStreamErrorCallback

Использование в Deno

import { type ReadableStreamErrorCallback } from "node:stream/web";

Сигнатуры вызова

(reason: any): void | PromiseLike<void>

интерфейс ReadableStreamGenericReader

Использование в Deno

import { type ReadableStreamGenericReader } from "node:stream/web";

Свойства

closed: Promise<undefined>

только для чтения

Методы

cancel(reason?: any): Promise<void>

интерфейс ReadableStreamGetReaderOptions

Использование в Deno

import { type ReadableStreamGetReaderOptions } from "node:stream/web";

Свойства

mode: ReadableStreamReaderMode

необязательный

Создает ReadableStreamBYOBReader и блокирует поток для нового средства чтения.

Этот вызов работает так же, как вариант без аргументов, за исключением того, что он применим только к читаемым потокам байтов, то есть потокам, специально созданным для чтения с использованием «собственного буфера». Возвращаемое средство чтения BYOB позволяет напрямую считывать отдельные фрагменты из потока с помощью метода read() в буферы, предоставленные разработчиком, обеспечивая более точный контроль над выделением памяти.

интерфейс ReadableStreamReadDoneResult

Использование в Deno

import { type ReadableStreamReadDoneResult } from "node:stream/web";

Параметры типа

T

Свойства

done: true

value: T

необязательный

интерфейс ReadableStreamReadValueResult

Использование в Deno

import { type ReadableStreamReadValueResult } from "node:stream/web";

Параметры типа

T

Свойства

done: false

value: T

интерфейс ReadableWritablePair

Использование в Deno

import { type ReadableWritablePair } from "node:stream/web";

Параметры типа

R = any

W = any

Свойства

readable: ReadableStream<R>

writable: WritableStream<W>

Предоставляет удобный способ связать в цепочку передачу этого читаемого потока через поток преобразования (или любую другую пару { writable, readable }). Он просто передает поток на записываемую сторону указанной пары и возвращает читаемую сторону для дальнейшего использования.

Передача потока блокирует его на время передачи, не позволяя другим потребителям получить средство чтения.

интерфейс StreamPipeOptions

Использование в Deno

import { type StreamPipeOptions } from "node:stream/web";

Свойства

preventAbort: boolean

необязательный

preventCancel: boolean

необязательный

preventClose: boolean

необязательный

Передает этот читаемый поток в указанный поток назначения для записи. Поведение процесса передачи при различных ошибках можно настроить с помощью ряда параметров. Возвращается промис, который выполняется при успешном завершении передачи или отклоняется, если возникли ошибки.

Передача потока блокирует его на время передачи, не позволяя другим потребителям получить средство чтения.

Ошибки и закрытие исходного потока и потока назначения распространяются следующим образом:

Ошибка в этом исходном читаемом потоке прервет поток назначения, если preventAbort не имеет истинного значения. Возвращенный промис будет отклонен с ошибкой исходного потока или с любой ошибкой, возникшей при прерывании потока назначения.

Ошибка в потоке назначения отменит этот исходный читаемый поток, если preventCancel не имеет истинного значения. Возвращенный промис будет отклонен с ошибкой потока назначения или с любой ошибкой, возникшей при отмене исходного потока.

При закрытии этого исходного читаемого потока поток назначения будет закрыт, если preventClose не имеет истинного значения. Возвращенный промис будет выполнен после завершения этого процесса, если при закрытии потока назначения не возникнет ошибка; в этом случае он будет отклонен с этой ошибкой.

Если поток назначения изначально закрыт или закрывается, этот исходный читаемый поток будет отменен, если preventCancel не имеет значения true. Возвращенный промис будет отклонен с ошибкой, указывающей на невозможность передачи в закрытый поток, или с любой ошибкой, возникшей при отмене исходного потока.

Параметру signal можно присвоить AbortSignal, чтобы разрешить прерывание выполняющейся операции передачи с помощью соответствующего AbortController. В этом случае этот исходный читаемый поток будет отменен, а поток назначения прерван, если этому не препятствуют соответствующие параметры preventCancel или preventAbort.

signal: AbortSignal

необязательный

интерфейс TextDecoderOptions

Использование в Deno

import { type TextDecoderOptions } from "node:stream/web";

Свойства

fatal: boolean

необязательный

ignoreBOM: boolean

необязательный

интерфейс TextDecoderStream

Использование в Deno

import { type TextDecoderStream } from "node:stream/web";

Свойства

encoding: string

только для чтения

Возвращает название кодировки в нижнем регистре.

fatal: boolean

только для чтения

Возвращает true, если режим обработки ошибок — "fatal", и false в противном случае.

ignoreBOM: boolean

только для чтения

Возвращает true, если установлен флаг игнорирования BOM, и false в противном случае.

readable: ReadableStream<string>

только для чтения

writable: WritableStream<BufferSource>

только для чтения

[[Symbol.toStringTag]]: string

только для чтения

переменная TextDecoderStream

Свойства

prototype: TextDecoderStream

Класс TextDecoderStream является глобальной ссылкой на import { TextDecoderStream } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-textdecoderstream

Тип

globalThis extends { onmessage: any; TextDecoderStream: infer T; } ? T : stream/web

интерфейс TextEncoderStream

Использование в Deno

import { type TextEncoderStream } from "node:stream/web";

Свойства

encoding: "utf-8"

только для чтения

Возвращает "utf-8".

readable: ReadableStream<Uint8Array>

только для чтения

writable: WritableStream<string>

только для чтения

[[Symbol.toStringTag]]: string

только для чтения

переменная TextEncoderStream

Свойства

prototype: TextEncoderStream

TextEncoderStream class — это глобальная ссылка для import { TextEncoderStream } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-textencoderstream

Тип

globalThis extends { onmessage: any; TextEncoderStream: infer T; } ? T : stream/web

интерфейс Transformer

Использование в Deno

import { type Transformer } from "node:stream/web";

Параметры типа

I = any

O = any

Свойства

flush: TransformerFlushCallback<O>

необязательный

readableType: undefined

необязательный

start: TransformerStartCallback<O>

необязательный

transform: TransformerTransformCallback<I, O>

необязательный

writableType: undefined

необязательный

интерфейс TransformerFlushCallback

Использование в Deno

import { type TransformerFlushCallback } from "node:stream/web";

Параметры типа

O

Сигнатуры вызова

(controller: TransformStreamDefaultController<O>): void | PromiseLike<void>

интерфейс TransformerStartCallback

Использование в Deno

import { type TransformerStartCallback } from "node:stream/web";

Параметры типа

O

Сигнатуры вызова

(controller: TransformStreamDefaultController<O>): any

интерфейс TransformerTransformCallback

Использование в Deno

import { type TransformerTransformCallback } from "node:stream/web";

Параметры типа

I

O

Сигнатуры вызова

(

chunk: I,

controller: TransformStreamDefaultController<O>,
): void | PromiseLike<void>

интерфейс TransformStream

Использование в Deno

import { type TransformStream } from "node:stream/web";

Параметры типа

I = any

O = any

Свойства

readable: ReadableStream<O>

только для чтения

writable: WritableStream<I>

только для чтения

Параметры типа

I = any

O = any

переменная TransformStream

Свойства

prototype: TransformStream

TransformStream class — это глобальная ссылка для import { TransformStream } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-transformstream

Тип

globalThis extends { onmessage: any; TransformStream: infer T; } ? T : stream/web

интерфейс TransformStreamDefaultController

Использование в Deno

import { type TransformStreamDefaultController } from "node:stream/web";

Параметры типа

O = any

Свойства

desiredSize: number | null

только для чтения

Методы

enqueue(chunk?: O): void

error(reason?: any): void

terminate(): void

Параметры типа

O = any

переменная TransformStreamDefaultController

Свойства

prototype: TransformStreamDefaultController

TransformStreamDefaultController class — это глобальная ссылка для import { TransformStreamDefaultController } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-transformstreamdefaultcontroller

Тип

globalThis extends { onmessage: any; TransformStreamDefaultController: infer T; } ? T : stream/web

интерфейс UnderlyingByteSource

Использование в Deno

import { type UnderlyingByteSource } from "node:stream/web";

Свойства

autoAllocateChunkSize: number

необязательный

cancel: ReadableStreamErrorCallback

необязательный

pull: ReadableByteStreamControllerCallback

необязательный

start: ReadableByteStreamControllerCallback

необязательный

type: "bytes"

интерфейс UnderlyingSink

Использование в Deno

import { type UnderlyingSink } from "node:stream/web";

Параметры типа

W = any

Свойства

abort: UnderlyingSinkAbortCallback

необязательный

close: UnderlyingSinkCloseCallback

необязательный

start: UnderlyingSinkStartCallback

необязательный

type: undefined

необязательный

write: UnderlyingSinkWriteCallback<W>

необязательный

интерфейс UnderlyingSinkAbortCallback

Использование в Deno

import { type UnderlyingSinkAbortCallback } from "node:stream/web";

Сигнатуры вызова

(reason?: any): void | PromiseLike<void>

интерфейс UnderlyingSinkCloseCallback

Использование в Deno

import { type UnderlyingSinkCloseCallback } from "node:stream/web";

Сигнатуры вызова

(): void | PromiseLike<void>

интерфейс UnderlyingSinkStartCallback

Использование в Deno

import { type UnderlyingSinkStartCallback } from "node:stream/web";

Сигнатуры вызова

(controller: WritableStreamDefaultController): any

интерфейс UnderlyingSinkWriteCallback

Использование в Deno

import { type UnderlyingSinkWriteCallback } from "node:stream/web";

Параметры типа

W

Сигнатуры вызова

(

chunk: W,

controller: WritableStreamDefaultController,
): void | PromiseLike<void>

интерфейс UnderlyingSource

Использование в Deno

import { type UnderlyingSource } from "node:stream/web";

Параметры типа

R = any

Свойства

cancel: UnderlyingSourceCancelCallback

необязательный

pull: UnderlyingSourcePullCallback<R>

необязательный

start: UnderlyingSourceStartCallback<R>

необязательный

type: undefined

необязательный

интерфейс UnderlyingSourceCancelCallback

Использование в Deno

import { type UnderlyingSourceCancelCallback } from "node:stream/web";

Сигнатуры вызова

(reason?: any): void | PromiseLike<void>

интерфейс UnderlyingSourcePullCallback

Использование в Deno

import { type UnderlyingSourcePullCallback } from "node:stream/web";

Параметры типа

R

Сигнатуры вызова

(controller: ReadableStreamController<R>): void | PromiseLike<void>

интерфейс UnderlyingSourceStartCallback

Использование в Deno

import { type UnderlyingSourceStartCallback } from "node:stream/web";

Параметры типа

R

Сигнатуры вызова

(controller: ReadableStreamController<R>): any

интерфейс WritableStream

Использование в Deno

import { type WritableStream } from "node:stream/web";

Этот интерфейс Streams API предоставляет стандартную абстракцию для записи потоковых данных в пункт назначения, называемый приёмником. Этот объект поддерживает встроенные механизмы обратного давления и очередей.

Параметры типа

W = any

Свойства

locked: boolean

только для чтения

Методы

abort(reason?: any): Promise<void>

close(): Promise<void>

getWriter(): WritableStreamDefaultWriter<W>

Параметры типа

W = any

переменная WritableStream

Свойства

prototype: WritableStream

Класс WritableStream является глобальной ссылкой на import { WritableStream } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-writablestream

Тип

globalThis extends { onmessage: any; WritableStream: infer T; } ? T : stream/web

интерфейс WritableStreamDefaultController

Использование в Deno

import { type WritableStreamDefaultController } from "node:stream/web";

Этот интерфейс Streams API представляет контроллер, который позволяет управлять состоянием WritableStream. При создании WritableStream базовый приёмник получает соответствующий экземпляр WritableStreamDefaultController для управления.

Методы

error(e?: any): void

переменная WritableStreamDefaultController

Свойства

prototype: WritableStreamDefaultController

Класс WritableStreamDefaultController является глобальной ссылкой на import { WritableStreamDefaultController } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-writablestreamdefaultcontroller

Тип

globalThis extends { onmessage: any; WritableStreamDefaultController: infer T; } ? T : stream/web

интерфейс WritableStreamDefaultWriter

Использование в Deno

import { type WritableStreamDefaultWriter } from "node:stream/web";

Этот интерфейс Streams API представляет собой объект, возвращаемый методом WritableStream.getWriter(). После создания он блокирует < поток записи в WritableStream, гарантируя, что никакие другие потоки не смогут записывать в базовый приёмник.

Параметры типа

W = any

Свойства

closed: Promise<undefined>

только для чтения

desiredSize: number | null

только для чтения

ready: Promise<undefined>

только для чтения

Методы

abort(reason?: any): Promise<void>

close(): Promise<void>

releaseLock(): void

write(chunk?: W): Promise<void>

Параметры типа

W = any

переменная WritableStreamDefaultWriter

Свойства

prototype: WritableStreamDefaultWriter

Класс WritableStreamDefaultWriter является глобальной ссылкой на import { WritableStreamDefaultWriter } from 'node:stream/web'. https://nodejs.org/api/globals.html#class-writablestreamdefaultwriter

Тип

globalThis extends { onmessage: any; WritableStreamDefaultWriter: infer T; } ? T : stream/web

псевдоним типа BufferSource

Использование в Deno

import { type BufferSource } from "node:stream/web";

Определение

ArrayBufferView | ArrayBuffer

псевдоним типа ReadableStreamController

Использование в Deno

import { type ReadableStreamController } from "node:stream/web";

Параметры типа

T

Определение

ReadableStreamDefaultController<T>

псевдоним типа ReadableStreamReader

Использование в Deno

import { type ReadableStreamReader } from "node:stream/web";

Параметры типа

T

Определение

ReadableStreamDefaultReader<T> | ReadableStreamBYOBReader

псевдоним типа ReadableStreamReaderMode

Использование в Deno

import { type ReadableStreamReaderMode } from "node:stream/web";

Определение

"byob"

псевдоним типа ReadableStreamReadResult

Использование в Deno

import { type ReadableStreamReadResult } from "node:stream/web";

Параметры типа

T

Определение

ReadableStreamReadValueResult<T> | ReadableStreamReadDoneResult<T>