Giter VIP home page Giter VIP logo

transform-file's Introduction

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
    });
  }
);

transform-file's People

Watchers

Moshe Kolodny avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.