npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

rw-stream

v0.3.3

Published

A simple stream that allows reading and writing to the same file at the same time.

Downloads

2,524

Readme

rw-stream

A stream that can substitute contents of a file in streaming fashion.

The aim of this module is to expose a readable and writable stream connected to a single file at the same time. It works similarily to fs.createReadStream and fs.createWriteStream, but allows writing and reading simultanously, without creating a new file or move operations.

This is achieved by disallowing any write operations to advance further than the current reading index. This module will then make sure that a byte of the file will be read before it's overwritten.

Note: In any case, the file will be accessed and it's contents may be overwritten even if there's no actual read operation done (due to node.js streams buffering mechanisms).

Usage:

const rw = require("../");

const {fd, readStream, writeStream} = await rw(path, options);

Arguments:

  • path string - the path of the file to access.
  • options object - options, currently none.

Returns an object with the following properties:

  • fd int - file descriptor number (from fs.open)
  • writeStream Writable - Writable stream for new file contents.
  • readStream Readable - Readable stream containing previous contents.

Samples

A simple module that replaces the contents of a file while keeping a backup:

const replaceAndBackup = async (newContentStream) => {
    const {readStream, writeStream} = await rw(path);

    readStream.pipe(fs.createWriteStream(`${path}.bak`));
    newContentStream.pipe(writeStream);

    return new Promise((res, rej) => writeStream.on('finish', res).on('error', rej));
}

Testing

For now there's just:

$ node test

Two tests will be executed:

  • one for file that's being grown.
  • one for file that's being shrinked.

We're working on more and proper tests.