🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Book a DemoInstallSign in
Socket

transform-file

Package Overview
Dependencies
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

transform-file

transform file in place using streams and temp files

1.0.1
latest
npm
Version published
Weekly downloads
7.4K
-4.23%
Maintainers
1
Weekly downloads
 
Created
Source

transform file

NPM version Build status Test coverage Downloads

Transform a file as a stream in place (with a temp file, but retaining inode info)

Usage

Take a look at the test folder for more usages, but the basic idea is you pass in a file, a transform callback and a done callback and it calls the transform callback on each chunk passing in a buffer and a boolean that's true if it's the last chunk in the file, the callback can be async or sync, by either accepting a third arg or not. Here's an example:

var transformFile = require('transform-file');

transformFile(
  __dirname + '/package.json',
  function(buffer, isLastChunk) {
    return buffer.toString().toUpperCase() + (isLastChunk ? '\n\n\n' : '');
  },
  function() {
    fs.readFile(__dirname + '/package.json', function(err, buffer) {
      console.log(buffer.toString()); // uppercase with trailing newlines
    });
  }
);

// same as above just async
transformFile(
  __dirname + '/package.json',
  function(buffer, isLastChunk, next) {
    setTimeout(function() {
      // notice we use next() and not return
      next(buffer.toString().toUpperCase() + (isLastChunk ? '\n\n\n' : ''));
    }, 10);
  },
  function() {
    fs.readFile(__dirname + '/package.json', function(err, buffer) {
      console.log(buffer.toString()); // uppercase with trailing newlines
    });
  }
);


FAQs

Package last updated on 10 May 2015

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts