write-file-utf8

writes content to file using utf-8 encoding, tries to create directory with mkdirp

Installation | API | Usage | See also | License

Installation

With npm do

npm install write-file-utf8

API

`write(filePath, content)`

It is an function that returns a Promise and requires the following parameters:

@param {String} filePath can be inside a nested folder that does not exist yet
@param {String|Buffer} content will be written using utf-8 encoding

Usage

import write from 'write-file-utf8'
// or use CommonJS
// const write = require('write-file-utf8')

// Nested folders will be created if they do not exist yet.
const filePath1 = '/tmp/foo/bar.txt'
const filePath2 = '/tmp/foo/bar/quz.txt'

const content = 'Hello'

// Since write-file-utf8 function will return a Promise,
// the most comfortable way to run it is inside an async function.
async function example () {
  try {
    // Write a string into file.
    //////////////////////////////////////////////////////////////////
    await write(filePath1, content)

    // Write a buffer into file.
    //////////////////////////////////////////////////////////////////
    const buffer = Buffer.from(content) // this is an utf-8 encoded buffer
    await write(filePath2, buffer)
  } catch (error) {
    // In case you do not have permissions to create folders,
    // you may want to handle it here.
    console.error(error)
  }
}

// Run example.
example()

License

MIT