@types/fs-extra

What is @types/fs-extra?

The @types/fs-extra package provides TypeScript type definitions for the fs-extra library, which is an extension of the Node.js standard 'fs' module. It adds file system methods that aren't included in the native 'fs' module and provides promise support. This package is essential for TypeScript developers using fs-extra to ensure type safety and to take advantage of IntelliSense and code completion features in their IDE.

What are @types/fs-extra's main functionalities?

File Copying

This feature allows for copying files and directories from one location to another. The code sample demonstrates how to use the async/await syntax to copy files.

import fs from 'fs-extra';

async function copyFiles() {
  try {
    await fs.copy('/path/to/source', '/path/to/dest');
    console.log('Files copied successfully!');
  } catch (err) {
    console.error(err);
  }
}

Reading and Writing JSON Files

This feature simplifies the process of reading and writing JSON files. The code sample shows how to read a JSON file, modify its content, and then write it back.

import fs from 'fs-extra';

async function readAndWriteJson() {
  try {
    const data = await fs.readJson('/path/to/some.json');
    console.log(data);
    data.newProp = 'newValue';
    await fs.writeJson('/path/to/some.json', data);
    console.log('JSON file updated successfully!');
  } catch (err) {
    console.error(err);
  }
}

Ensuring a Directory Exists

This feature checks if a directory exists, and if it does not, creates it. The code sample demonstrates how to ensure a directory exists.

import fs from 'fs-extra';

async function ensureDir() {
  try {
    await fs.ensureDir('/path/to/dir');
    console.log('Directory exists or was created successfully!');
  } catch (err) {
    console.error(err);
  }
}

Other packages similar to @types/fs-extra

mkdirp

Similar to the 'ensureDir' functionality of fs-extra, mkdirp allows creating nested directories. The main difference is that mkdirp focuses solely on directory creation, whereas fs-extra offers a broader range of file system operations.

rimraf

Rimraf provides functionality similar to the 'remove' method in fs-extra, allowing for the deletion of files and directories. It mimics the UNIX command 'rm -rf', offering a powerful way to remove files. fs-extra includes this functionality and much more, making it a more comprehensive solution.

graceful-fs

Graceful-fs wraps the fs module to make it more robust and adds features to improve handling of file system operations, such as queuing and retrying. While fs-extra also enhances the native fs module, it focuses more on adding new methods and providing promise support rather than solely improving reliability.

README

Installation

npm install --save @types/fs-extra

Summary

This package contains type definitions for fs-extra (https://github.com/jprichardson/node-fs-extra).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/fs-extra.

Additional Details

• Last updated: Tue, 07 Nov 2023 20:08:00 GMT
• Dependencies: @types/jsonfile, @types/node

Credits

These definitions were written by Alan Agius, midknight41, Brendan Forster, Mees van Dijk, Justin Rockwood, Sang Dang, Florian Keller, Piotr Błażejewicz, Tiger Oakes, and BendingBender.