Spec-Zone.ru › Deno 2

Потоки

Управление потоками данных, стратегиями организации очередей и преобразованиями. Обрабатывайте данные фрагментами, большие наборы данных и оптимизируйте использование памяти.

Например, ReadableStream, WritableStream, TransformStream


интерфейс ByteLengthQueuingStrategy

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

Свойства

highWaterMark: number
только для чтения
size: QueuingStrategySize<ArrayBufferView>
только для чтения

переменная ByteLengthQueuingStrategy

Объект-конструктор для ByteLengthQueuingStrategy, используемый для создания стратегии организации очереди, которая оценивает каждый фрагмент по его byteLength относительно верхнего порога потока.

Свойства

prototype: ByteLengthQueuingStrategy
только для чтения

интерфейс CompressionStream

расширяет GenericTransformStream

API для сжатия потока данных.

Примеры

await Deno.stdin.readable
  .pipeThrough(new CompressionStream("gzip"))
  .pipeTo(Deno.stdout.writable);

Свойства

readable: ReadableStream<Uint8Array<ArrayBuffer>>
только для чтения
writable: WritableStream<BufferSource>
только для чтения

переменная CompressionStream

API для сжатия потока данных.

Примеры

await Deno.stdin.readable
  .pipeThrough(new CompressionStream("gzip"))
  .pipeTo(Deno.stdout.writable);

Свойства

prototype: CompressionStream
только для чтения

интерфейс CountQueuingStrategy

расширяет QueuingStrategy

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

Свойства

highWaterMark: number
только для чтения
size: QueuingStrategySize
только для чтения

переменная CountQueuingStrategy

Объект-конструктор для CountQueuingStrategy, используемый для создания стратегии организации очереди, которая учитывает каждый фрагмент как одну единицу относительно верхнего порога потока.

Свойства

prototype: CountQueuingStrategy
только для чтения

интерфейс DecompressionStream

расширяет GenericTransformStream

API для распаковки потока данных.

Примеры

const input = await Deno.open("./file.txt.gz");
const output = await Deno.create("./file.txt");

await input.readable
  .pipeThrough(new DecompressionStream("gzip"))
  .pipeTo(output.writable);

Свойства

readable: ReadableStream<Uint8Array<ArrayBuffer>>
только для чтения
writable: WritableStream<BufferSource>
только для чтения

переменная DecompressionStream

API для распаковки потока данных.

Примеры

const input = await Deno.open("./file.txt.gz");
const output = await Deno.create("./file.txt");

await input.readable
  .pipeThrough(new DecompressionStream("gzip"))
  .pipeTo(output.writable);

Свойства

prototype: DecompressionStream
только для чтения

интерфейс GenericTransformStream

Свойства

readable: ReadableStream
только для чтения
writable: WritableStream
только для чтения

интерфейс QueuingStrategy

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

T = any

Свойства

highWaterMark: number
необязательное
size: QueuingStrategySize<T>
необязательное

интерфейс QueuingStrategyInit

Свойства

highWaterMark: number

интерфейс QueuingStrategySize

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

T = any

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

(chunk: T): number

интерфейс ReadableByteStreamController

Свойства

byobRequest: ReadableStreamBYOBRequest | null
только для чтения
desiredSize: number | null
только для чтения

Методы

close(): void
enqueue(chunk: ArrayBufferView): void
error(e?: any): void

переменная ReadableByteStreamController

Объект-конструктор для ReadableByteStreamController.

Экземпляры передаются в функции обратного вызова базового источника ReadableStream, ориентированного на байты, а не создаются напрямую, поэтому вызов конструктора приводит к исключению.

Свойства

prototype: ReadableByteStreamController
только для чтения

интерфейс ReadableStream

Этот интерфейс Streams API представляет читаемый поток байтовых данных. Fetch API предоставляет экземпляр ReadableStream через свойство body объекта Response.

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

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?: ReadableStreamIteratorOptions): AsyncIterableIterator<R>
[[Symbol.asyncIterator]](options?: ReadableStreamIteratorOptions): AsyncIterableIterator<R>

переменная ReadableStream

Объект-конструктор для ReadableStream, используемый для создания читаемого потока на основе базового источника, описывающего, как данные помещаются в очередь и считываются.

Свойства

prototype: ReadableStream
только для чтения

Методы

from<R>(asyncIterable: AsyncIterable<R> | Iterable<R | PromiseLike<R>> & object): ReadableStream<R>

интерфейс ReadableStreamBYOBReader

расширяет ReadableStreamGenericReader

Методы

read<T extends ArrayBufferView>(
view: T,
options?: ReadableStreamBYOBReaderReadOptions,
): Promise<ReadableStreamReadResult<T>>
releaseLock(): void

переменная ReadableStreamBYOBReader

Объект-конструктор для ReadableStreamBYOBReader, используемый для создания средства чтения «со своим буфером», привязанного к заданному байтовому потоку. Большинство программ получают его с помощью ReadableStream.getReader({ mode: "byob" }).

Свойства

prototype: ReadableStreamBYOBReader
только для чтения

интерфейс ReadableStreamBYOBReaderReadOptions

Свойства

min: number
необязательное

интерфейс ReadableStreamBYOBRequest

Свойства

view: Uint8Array<ArrayBuffer> | null
только для чтения

Методы

respond(bytesWritten: number): void
respondWithNewView(view: ArrayBufferView): void

переменная ReadableStreamBYOBRequest

Объект-конструктор для ReadableStreamBYOBRequest.

Экземпляры передаются контроллеру байтового потока, а не создаются напрямую, поэтому вызов конструктора приводит к исключению.

Свойства

prototype: ReadableStreamBYOBRequest
только для чтения

интерфейс ReadableStreamDefaultController

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

R = any

Свойства

desiredSize: number | null
только для чтения

Методы

close(): void
enqueue(chunk?: R): void
error(e?: any): void

переменная ReadableStreamDefaultController

Объект-конструктор для ReadableStreamDefaultController.

Экземпляры передаются в функции обратного вызова базового источника ReadableStream, а не создаются напрямую, поэтому вызов конструктора приводит к исключению.

Свойства

prototype: ReadableStreamDefaultController
только для чтения

интерфейс ReadableStreamDefaultReader

расширяет ReadableStreamGenericReader

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

R = any

Методы

read(): Promise<ReadableStreamReadResult<R>>
releaseLock(): void

переменная ReadableStreamDefaultReader

Объект-конструктор для ReadableStreamDefaultReader, используемый для создания читателя по умолчанию, заблокированного на указанном ReadableStream. Обычно код получает его через ReadableStream.getReader.

Свойства

prototype: ReadableStreamDefaultReader
только для чтения

интерфейс ReadableStreamGenericReader

Свойства

closed: Promise<void>
только для чтения

Методы

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

интерфейс ReadableStreamGetReaderOptions

Свойства

mode: ReadableStreamReaderMode
необязательное

интерфейс ReadableStreamIteratorOptions

Свойства

preventCancel: boolean
необязательное

интерфейс ReadableStreamReadDoneResult

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

T

Свойства

done: true
value: T
необязательное

интерфейс ReadableStreamReadValueResult

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

T

Свойства

done: false
value: T

интерфейс ReadableWritablePair

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

R = any
W = any

Свойства

readable: ReadableStream<R>
writable: WritableStream<W>

интерфейс StreamPipeOptions

Свойства

preventAbort: boolean
необязательное
preventCancel: boolean
необязательное
preventClose: boolean
необязательное
signal: AbortSignal
необязательное

интерфейс Transformer

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

I = any
O = any

Свойства

flush: TransformerFlushCallback<O>
необязательное
readableType: undefined
необязательное
start: TransformerStartCallback<O>
необязательное
transform: TransformerTransformCallback<I, O>
необязательное
cancel: TransformerCancelCallback
необязательное
writableType: undefined
необязательное

интерфейс TransformerCancelCallback

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

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

интерфейс TransformerFlushCallback

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

O

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

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

интерфейс TransformerStartCallback

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

O

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

(controller: TransformStreamDefaultController<O>): any

интерфейс TransformerTransformCallback

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

I
O

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

(
chunk: I,
controller: TransformStreamDefaultController<O>,
): void | PromiseLike<void>

интерфейс TransformStream

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

I = any
O = any

Свойства

readable: ReadableStream<O>
только для чтения
writable: WritableStream<I>
только для чтения

переменная TransformStream

Объект-конструктор для TransformStream, используемый для создания потока преобразования из трансформера, описывающего, как фрагменты данных, считанные с его записываемой стороны, преобразуются перед появлением на его читаемой стороне.

Свойства

prototype: TransformStream
только для чтения

интерфейс TransformStreamDefaultController

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

O = any

Свойства

desiredSize: number | null
только для чтения

Методы

enqueue(chunk?: O): void
error(reason?: any): void
terminate(): void

переменная TransformStreamDefaultController

Объект-конструктор для TransformStreamDefaultController.

Экземпляры передаются в функции обратного вызова трансформера TransformStream, а не создаются напрямую, поэтому вызов конструктора приводит к ошибке.

Свойства

prototype: TransformStreamDefaultController
только для чтения

интерфейс UnderlyingByteSource

Свойства

autoAllocateChunkSize: number
необязательное
cancel: UnderlyingSourceCancelCallback
необязательное
pull: (controller: ReadableByteStreamController) => void | PromiseLike<void>
необязательное
start: (controller: ReadableByteStreamController) => any
необязательное
type: "bytes"

интерфейс UnderlyingDefaultSource

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

R = any

Свойства

cancel: UnderlyingSourceCancelCallback
необязательное
pull: (controller: ReadableStreamDefaultController<R>) => void | PromiseLike<void>
необязательное
start: (controller: ReadableStreamDefaultController<R>) => any
необязательное
type: undefined
необязательное

интерфейс UnderlyingSink

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

W = any

Свойства

abort: UnderlyingSinkAbortCallback
необязательное
close: UnderlyingSinkCloseCallback
необязательное
start: UnderlyingSinkStartCallback
необязательное
type: undefined
необязательное
write: UnderlyingSinkWriteCallback<W>
необязательное

интерфейс UnderlyingSinkAbortCallback

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

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

интерфейс UnderlyingSinkCloseCallback

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

(): void | PromiseLike<void>

интерфейс UnderlyingSinkStartCallback

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

(controller: WritableStreamDefaultController): any

интерфейс UnderlyingSinkWriteCallback

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

W

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

(
chunk: W,
controller: WritableStreamDefaultController,
): void | PromiseLike<void>

интерфейс UnderlyingSource

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

R = any

Свойства

autoAllocateChunkSize: number
необязательное
cancel: UnderlyingSourceCancelCallback
необязательное
pull: UnderlyingSourcePullCallback<R>
необязательное
start: UnderlyingSourceStartCallback<R>
необязательное
type: ReadableStreamType
необязательное

интерфейс UnderlyingSourceCancelCallback

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

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

интерфейс UnderlyingSourcePullCallback

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

R

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

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

интерфейс UnderlyingSourceStartCallback

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

R

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

(controller: ReadableStreamController<R>): any

интерфейс WritableStream

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

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

W = any

Свойства

locked: boolean
только для чтения

Методы

abort(reason?: any): Promise<void>
close(): Promise<void>
getWriter(): WritableStreamDefaultWriter<W>

переменная WritableStream

Объект-конструктор для WritableStream, используемый для создания потока записи на основе нижележащего приемника, описывающего обработку записываемых фрагментов.

Свойства

prototype: WritableStream
только для чтения

интерфейс WritableStreamDefaultController

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

Свойства

signal: AbortSignal
только для чтения

Методы

error(e?: any): void

переменная WritableStreamDefaultController

Объект-конструктор для WritableStreamDefaultController.

Экземпляры передаются в функции обратного вызова нижележащего приемника объекта WritableStream, а не создаются напрямую, поэтому вызов конструктора приводит к исключению.

Свойства

prototype: WritableStreamDefaultController
только для чтения

интерфейс WritableStreamDefaultWriter

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

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

W = any

Свойства

closed: Promise<void>
только для чтения
desiredSize: number | null
только для чтения
ready: Promise<void>
только для чтения

Методы

abort(reason?: any): Promise<void>
close(): Promise<void>
releaseLock(): void
write(chunk?: W): Promise<void>

переменная WritableStreamDefaultWriter

Объект-конструктор для WritableStreamDefaultWriter, используемый для создания писателя, блокирующего указанный WritableStream. Обычно код получает его с помощью WritableStream.getWriter.

Свойства

prototype: WritableStreamDefaultWriter
только для чтения

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

Определение

"deflate"
| "deflate-raw"
| "gzip"
| "brotli"

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

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

T

Определение

ReadableStreamDefaultController<T> | ReadableByteStreamController

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

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

T

Определение

ReadableStreamDefaultReader<T> | ReadableStreamBYOBReader

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

Определение

"byob"

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

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

T

Определение

ReadableStreamReadValueResult<T> | ReadableStreamReadDoneResult<T>

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

Определение

"bytes"

© 2018–2025 the Deno authors
Licensed under the MIT License.
https://docs.deno.com/api/web/streams

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API