Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

next-chunk

1.0.2 • Public • Published

npm version build status coverage status

next-chunk

This package provides an easy mechanism to read the first chunk in a readable stream. It returns a promise which will be resolved with the chunk (either a Buffer or a string), or null if the stream was ended. It rejects the promise if an error occured on the stream.

API

Importing

If importing using TypeScript or ES6 modules:

import nextChunk from 'next-chunk'

and if importing using CommonJS require:

const { nextChunk } = require( 'next-chunk' );
// or, if preferred
const nextChunk = require( 'next-chunk' ).default;

Usage

const readable = getSomeReadableStream( );
 
const firstChunk = await nextChunk( readable );
const secondChunk = await nextChunk( readable );
// ... eventually the stream may end, we get
const endedChunk = await nextChunk( readable );
const againChunk = await nextChunk( readable );
 
// These chunks contain buffers or strings
expect( firstChunk ).to.not.be.null;
expect( secondChunk ).to.not.be.null;
// These are all null
expect( endedChunk ).to.be.null;
expect( againChunk ).to.be.null;

Install

npm i next-chunk

DownloadsWeekly Downloads

11

Version

1.0.2

License

MIT

Last publish

Collaborators

  • avatar