https://github.com/nwtgck/readable-stream-sized-reader-npm

ReadableStream Reader with byte length read(n) for JavaScript/TypeScript
https://github.com/nwtgck/readable-stream-sized-reader-npm

binary javascript read readablestream reader stream typescript

Last synced: 15 days ago
JSON representation

ReadableStream Reader with byte length read(n) for JavaScript/TypeScript

• Host: GitHub
• URL: https://github.com/nwtgck/readable-stream-sized-reader-npm
• Owner: nwtgck
• License: mit
• Created: 2020-02-22T11:59:34.000Z (over 6 years ago)
• Default Branch: develop
• Last Pushed: 2024-04-11T13:23:43.000Z (about 2 years ago)
• Last Synced: 2025-02-06T11:56:04.377Z (over 1 year ago)
• Topics: binary, javascript, read, readablestream, reader, stream, typescript
• Language: TypeScript
• Homepage:
• Size: 428 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# readable-stream-sized-reader

[![Node CI](https://github.com/nwtgck/readable-stream-sized-reader-npm/actions/workflows/ci.yml/badge.svg)](https://github.com/nwtgck/readable-stream-sized-reader-npm/actions/workflows/ci.yml)

ReadableStream Reader with specified byte length read()

## Usage

```js

const readable = ...; // ReadableStream, e.g. (await fetch("...")).body

const reader = new ReadableStreamSizedReader(readable.getReader());

while(true) {

  // Read 1024 bytes at most

  const { done, value } = await reader.read(1024);

  if (done) break;

  console.log('value:', value);

}

```

### Disable read-as-possible

By default, `.read(n)` reads n bytes as possible. When you use `await reader.read(1024, false)`, it read at most 1024 bytes, but sometimes the bytes can be less than 1024 bytes.