browser-stream-util

browser-stream-util

utility functions for web streams

• Streams API

API

Table of Contents

• iteratorToStream
  • Parameters
• stringToStream
  • Parameters
• uint8ToStream
  • Parameters
• streamToString
  • Parameters
• streamToUint8Array
  • Parameters
• streamToUint8Array
  • Parameters
• emptyStream

iteratorToStream

Converts an iterator into a ReadableStream.

Parameters

• iterator (AsyncIterator<Uint8Array> | Iterator<Uint8Array>)

Returns ReadableStream

stringToStream

Encodes a string into a ReadableStream.

Parameters

• str string
• encoder TextEncoder? (optional, default new TextEncoder())

Returns ReadableStream

uint8ToStream

Encodes a uint8 array into a ReadableStream.

Parameters

• array Uint8Array

Returns ReadableStream

streamToString

Reads web stream content into a string.

Parameters

• stream ReadableStream
• decoder TextDecoder? (optional, default new TextDecoder())

Returns Promise<string>

streamToUint8Array

Reads web stream content into a Uint8Array.

Parameters

• stream ReadableStream
• maxByteLength number

Returns Promise<Uint8Array>

streamToUint8Array

Reads web stream content into a Uint8Array.

Parameters

• stream ReadableStream

Returns Promise<Uint8Array>

emptyStream

Delivers a zero length ReadableStream with no data.

Returns ReadableStream

install

With npm do:

npm install browser-stream-util

license

BSD-2-Clause