https://github.com/bergos/stream-chunks

Get all chunks of a stream
https://github.com/bergos/stream-chunks

Last synced: 5 months ago
JSON representation

Get all chunks of a stream

• Host: GitHub
• URL: https://github.com/bergos/stream-chunks
• Owner: bergos
• License: mit
• Created: 2022-10-02T14:44:26.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-12-07T14:51:08.000Z (7 months ago)
• Last Synced: 2025-01-09T08:58:30.712Z (6 months ago)
• Language: JavaScript
• Size: 21.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# stream-chunks

[![build status](https://img.shields.io/github/actions/workflow/status/bergos/stream-chunks/test.yaml?branch=master)](https://github.com/bergos/stream-chunks/actions/workflows/test.yaml)

[![npm version](https://img.shields.io/npm/v/stream-chunks.svg)](https://www.npmjs.com/package/stream-chunks)

Get all chunks of a stream.

## Install

`npm install stream-chunks --save`

## Usage

There are multiple functions for collecting the chunks of a stream.

All of them are async functions, and expect the stream as the first argument.

### Raw as array

The `chunks` function collects all chunks and puts them in order in an array. 

```javascript

import chunks from 'stream-chunks/chunks.js'

const array = await chunks(stream)

```

### Combined into an Uint8Array

The `concat` function collects all chunks and combines them into a single Uint8Array object.

```javascript

import concat from 'stream-chunks/concat.js'

const all = await concat(stream)

```

### Combined into a string

The `decode` function collects all chunks, decodes them based on the given encoding, and combines them into a string.

```javascript

import decode from 'stream-chunks/decode.js'

const str = await decode(stream, 'utf8')

```