Skip to content

ryanve/map-file

Repository files navigation

Map a file into another file in Node.js

npm install map-file

API

mapFile({from, to, map=identity}, callback=done)

  • from is the reading filename
    • supports relative or absolute
  • to is the writing filename
    • supports relative or absolute
    • makes nonexistent directories via fs.mkdir
  • map is the function you use to map the content
    • default returns the original text
  • callback is a function to call after mapping
    • default throws errors and logs success

Usage

const mapFile = require("map-file")

Copy file

mapFile({
  from: "original.css",
  to: "copy.css",
})

Trim file

mapFile({
  from: "example.css",
  to: "example.css",
  map: text => text.trim(),
})

Slice file

mapFile({
  from: "full.md",
  to: "summary.md",
  map: text => text.slice(0, 200),
})

Callback

mapFile({
  from: "source.txt",
  to: "target.txt",
  map: text => text,
}, err => {
  if (err) throw err
  // ...
})