@scarafone/files-helper v0.0.9

@scarafone/files-helper

Node utility wrapper around base file system functions to provide ease of use functionality for reading, writing and deleting files to the local system that are expected to be in JSON or JS format with utf-8 encoding.

You can pass options through to underlying functions and it will override the defaults. You can also pass false to the parseAsJSON boolean value and it will return the original buffer unchanged.

Usage Guide

The test cases should do a good job providing how the functions work if you need further details.

/// Import
const { 
    closeFile, 
    deleteFile,
    ensureDirectoryExistence,
    createDirectory,
    deleteDirectory,
    readDirectory, 
    readFile, 
    writeFile 
    } = require("@scarafone/files-helper")

/// Execution
// Functions are synchronous

// General use case is for JSON formatted objects, or JS files.
const fileLocation = "./test/location/results.json"

// Write File
// If true, will ensure filepath exists before writing file
const file = writeFile(filePath: fileLocation, data: JSON.stringify({ "key": "value" }), shouldEnsurePathExists: true)

// Read File
// If true, it will return an empty file
file = readFile(filePath: fileLocation, options: {...options}, parseAsJSON: true ) // Default is true

// Delete File
// If true, it won't fail, but path will be created and deleted
const isSuccess = deleteFile(filePath: fileLocation, shouldEnsurePathExists: true)

Wrap in try/catch blocks in order to catch exceptions raised. Generally speaking though if shouldEnsurePathExists is true the operation is not likely to fail in most cases.