@types/minipass

What is @types/minipass?

@types/minipass provides TypeScript type definitions for the minipass package, which is a minimalistic stream implementation that supports both readable and writable streams. It is designed to be a simpler alternative to Node.js streams, with a focus on ease of use and performance.

What are @types/minipass's main functionalities?

Readable Stream

This feature allows you to create a readable stream using Minipass. The code sample demonstrates how to create a Minipass instance, listen for 'data' events, and write data to the stream.

const Minipass = require('minipass');
const mp = new Minipass();
mp.on('data', (chunk) => {
  console.log('Data:', chunk.toString());
});
mp.write('Hello, ');
mp.write('world!');
mp.end();

Writable Stream

This feature allows you to create a writable stream using Minipass. The code sample demonstrates how to create a Minipass instance, write data to the stream, and pipe the stream to process.stdout.

const Minipass = require('minipass');
const mp = new Minipass();
mp.write('Hello, ');
mp.write('world!');
mp.end();
mp.pipe(process.stdout);

Transform Stream

This feature allows you to create a transform stream using Minipass. The code sample demonstrates how to extend the Minipass class to create a custom transform stream that converts input data to uppercase.

const Minipass = require('minipass');
class UpperCaseStream extends Minipass {
  write(chunk) {
    super.write(chunk.toString().toUpperCase());
  }
}
const mp = new UpperCaseStream();
mp.pipe(process.stdout);
mp.write('hello, ');
mp.write('world!');
mp.end();

Other packages similar to @types/minipass

through2

through2 is a tiny wrapper around Node.js streams2 Transform to avoid explicit subclassing noise. It provides a simple API for creating transform streams. Compared to Minipass, through2 is more focused on transform streams and may require more boilerplate code for readable and writable streams.

readable-stream

readable-stream is a Node.js module that provides a standard, cross-platform stream implementation. It is a more comprehensive and feature-rich alternative to Minipass, supporting all types of streams (readable, writable, duplex, and transform) with a consistent API.

stream

stream is the core stream module in Node.js, providing a comprehensive API for working with streams. It is more complex and feature-rich compared to Minipass, offering fine-grained control over stream behavior and performance optimizations.

README

This is a stub types definition for @types/minipass (https://github.com/isaacs/minipass#readme).

minipass provides its own type definitions, so you don't need @types/minipass installed!