copyFile

Copy a file from src to dest. Does not copy directory trees.

Basic usage

import { copyFile } from '@rush-fs/core'
import { constants } from 'node:fs'
 
await copyFile('./a.txt', './b.txt')
await copyFile('./a.txt', './b.txt', constants.COPYFILE_EXCL) // fail if dest exists

Methods

copyFile(src, dest, mode?)

Async. Returns Promise<void>.

copyFileSync(src, dest, mode?)

Sync. Same arguments; throws on error.

Performance

From repo benchmarks (pnpm build && pnpm bench):

Rush-FS is much faster for single-file copy due to efficient native I/O.

Notes

• Directories: Use cp with recursive: true for directory trees. copyFile only copies a single file.
• COPYFILE_EXCL: Use constants.COPYFILE_EXCL from node:fs (or the numeric value) to avoid overwriting an existing destination.