downloads
Across all versions.
Download trend unavailable.
compatibility
Runtime metadata.
keywords
Tagged topics.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
polyfills, and extensions, of the core fs module.
fs.cp polyfill for node < 16.7.0fs.withTempDir addedfs.readdirScoped addedfs.moveFile addedfs.withTempDir(root, fn, options) -> Promiseroot: the directory in which to create the temporary directoryfn: a function that will be called with the path to the temporary directoryoptions
tmpPrefix: a prefix to be used in the generated directory nameThe withTempDir function creates a temporary directory, runs the provided
function (fn), then removes the temporary directory and resolves or rejects
based on the result of fn.
const fs = require('@npmcli/fs')
const os = require('os')
// this function will be called with the full path to the temporary directory
// it is called with `await` behind the scenes, so can be async if desired.
const myFunction = async (tempPath) => {
return 'done!'
}
const main = async () => {
const result = await fs.withTempDir(os.tmpdir(), myFunction)
// result === 'done!'
}
main()fs.readdirScoped(root) -> Promiseroot: the directory to readLike fs.readdir but handling @org/module dirs as if they were
a single entry.
const { readdirScoped } = require('@npmcli/fs')
const entries = await readdirScoped('node_modules')
// entries will be something like: ['a', '@org/foo', '@org/bar']fs.moveFile(source, dest, options) -> PromiseA fork of move-file with support for Common JS.
source: File, or directory, you want to move.dest: Where you want the file or directory moved.options
overwrite (boolean, default: true): Overwrite existing destination file(s).The built-in
fs.rename()
is just a JavaScript wrapper for the C rename(2) function, which doesn't
support moving files across partitions or devices. This module is what you
would have expected fs.rename() to be.
const { moveFile } = require('@npmcli/fs');
(async () => {
await moveFile('source/unicorn.png', 'destination/unicorn.png');
console.log('The file has been moved');
})();Estimated unpacked size across 2 packages.
141.9 kB
Includes dependencies.
npm-cli-ops
npm-cli+bot@github.com