Numerous Packages Multiply

    fsxt
    TypeScript icon, indicating that this package has built-in type declarations

    13.0.1 • Public • Published

    fsxt

    Improved fork of fs-extra with extra [sic] features (and semicolons!)
    fsxt provides support for node.js 10 and above.

    JavaScript Style Guide Used by practically no-one Travis Build Status AppVeyor Build Status GitHub issues GitHub closed issues GitHub pull requests GitHub closed pull requests GitHub contributors Licensed under MIT Maintenance David David

    Installation

    npm install --save fsxt
    

    Or install with your preferred package manager (yarn, pnpm, ...)

    Usage

    fsxt is a drop-in replacement for the node.js core fs module. All methods in fs can be used in their standard forms in fsxt, with some improvements.

    You don't ever need to include the original fs module again:

    const fs = require('fs'); // this is no longer necessary

    you can now do this:

    const fs = require('fsxt');

    or if you prefer to make it clear that you're using fsxt and not fs, you may want to name your fs variable fsxt like so:

    const fsxt = require('fsxt');

    you can also keep both, but it's redundant:

    const fs = require('fs');
    const fsxt = require('fsxt');

    Improvements on fs

    All the improvements from mz/fs are included, which also includes improvements from graceful-fs.

    Most methods are async by default, returning a Promise that resolves to the method's result, or rejects if the operation fails.

    Sync methods on the other hand will throw if an error occurs, and directly return the resulting value to the caller if the operation succeeds.

    You can also use the methods in the legacy node.js form, passing a callback as the last parameter, as a function that takes (Error, <result>) parameters, but it's not recommended, and those variants may be removed in a later (major) version.

    Additionally, see notes on fs.read() & fs.write() if you're using either method.

    Example use:

    const fs = require('fsxt');
    
    // Async with promises:
    fs.copy('/tmp/myfile', '/tmp/mynewfile')
      .then(() => console.log('success!'))
      .catch(err => console.error(err));
    
    // Async with callbacks:
    fs.copy('/tmp/myfile', '/tmp/mynewfile', err => {
      if (err) return console.error(err);
      console.log('success!');
    });
    
    // Sync:
    try {
      fs.copySync('/tmp/myfile', '/tmp/mynewfile');
      console.log('success!');
    } catch (err) {
      console.error(err);
    }
    
    // Async/Await:
    async function copyFiles () {
      try {
        await fs.copy('/tmp/myfile', '/tmp/mynewfile');
        console.log('success!');
      } catch (err) {
        console.error(err);
      }
    }
    
    copyFiles();

    Methods

    The documentation is available at https://uwx-node-modules.github.io/fsxt/typedoc/globals.html.

    You can also find the documentation for just the methods added in fsxt that aren't in fs-extra at https://uwx-node-modules.github.io/fsxt/typedoc-fsxt-only/globals.html.

    The docs don't include descriptions for methods inherited from fs-extra, but you can find them here:

    The core node.js fs module methods are also available; although the node.js documentation doesn't show Promise overloads of the async methods, you can find them at:

    Third Party

    File / Directory Watching

    If you want to watch for changes to files or directories, then you should use chokidar.

    Misc.

    • mfs - Monitor your fsxt calls.

    Hacking on fsxt

    Do you want to hack on fsxt? Well, you probably shouldn't. Still, you can go ahead and send a PR.

    Please, no changes to anything in the lib folder; the contents of that folder are almost entirely verbatim from fs-extra, so they should be submitted upstream.

    fsxt uses the Google Style. It's pretty.

    Running the Test Suite

    fsxt contains like at least 4 tests that pass.

    • npm run lint: runs eslint
    • npm run unit: runs the unit tests
    • npm test: runs both the linter and the tests

    Windows

    If you run the tests on the Windows and receive a lot of symbolic link EPERM permission errors, it's because on Windows you need elevated privilege to create symbolic links. You can either run the tests as Administrator or run node testlite to test only fsxt-exclusive methods, which doesn't include symbolic links

    Legal

    Licensed under MIT. Full license text available at LICENSE.txt

    fs-extra is copyright (c) 2011-2017 JP Richardson

    fsxt is copyright © 2016-2018 uwx, some rights reserved.

    Parts of the documentation were taken from other modules and the Node.js fs module. Relevant licenses are included at the following locations:

    fs-extra and fsxt are not endorsed by or affiliated with Joyent or the Node.js Foundation. fsxt is not endorsed by or affiliated with JP Richardson.

    Install

    npm i fsxt

    DownloadsWeekly Downloads

    1

    Version

    13.0.1

    License

    MIT

    Unpacked Size

    310 kB

    Total Files

    53

    Last publish

    Collaborators

    • zas