copyFile

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

Basic usage

import { copyFile } from '@vooya/fs'
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):

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

Local scale report

Generated from local performance reports. Do not edit this block by hand.

• Runtime: v22.22.0 on darwin/arm64
• Samples: 2 warmup runs, 10 measured runs
• Aggregation: trimmed mean for wall-clock time; average per-run memory delta for RSS

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.
• Known gap: Missing-path and existing-destination errors currently have Node-like messages, but do not expose Node-style code, path, dest, and syscall fields yet.
• Unsupported Node inputs: Buffer paths and URL paths are not part of the current Vooya FS copyFile surface.
• Unsupported reflink guarantee: COPYFILE_FICLONE_FORCE currently falls back to ordinary copy instead of requiring copy-on-write support.

Competitor measurements

See the full copyFile comparison table for Node 22/24, peer libraries, sync/Promise modes, small and batch workloads, execution routes and measurement limits.