パッケージの詳細

fs-copy-file-sync

coderaiser83.5kMIT1.1.1

fs.copyFileSync ponyfill

ponyfill, copy, file, copyFileSync

readme

fs-copy-file-sync License NPM version Dependency Status Build Status Coverage Status

Node.js v8.5.0 fs.copyFileSync ponyfill.

Synchronously copies src to dest. By default, dest is overwritten if it already exists. Returns undefined. Node.js makes no guarantees about the atomicity of the copy operation. If an error occurs after the destination file has been opened for writing, Node.js will attempt to remove the destination.

Install

npm i fs-copy-file-sync-sync

API

flags is an optional integer that specifies the behavior of the copy operation. It is possible to create a mask consisting of the bitwise OR of two or more values (e.g. fs.constants.COPYFILE_EXCL | fs.constants.COPYFILE_FICLONE).

  • fs.constants.COPYFILE_EXCL - The copy operation will fail if dest already exists.
  • fs.constants.COPYFILE_FICLONE - The copy operation will attempt to create a copy-on-write reflink. If the platform does not support copy-on-write, then a fallback copy mechanism is used.
  • fs.constants.COPYFILE_FICLONE_FORCE - The copy operation will attempt to create a copy-on-write reflink. If the platform does not support copy-on-write, then the operation will fail.

Example:

const copyFileSync = require('fs-copy-file-sync');

// destination.txt will be created or overwritten by default.
copyFileSync('source.txt', 'destination.txt');
console.log('source.txt was copied to destination.txt');

If the third argument is a number, then it specifies flags, as shown in the following example.

const copyFileSync = require('fs-copy-file-sync');
const { COPYFILE_EXCL } = copyFileSync.constants;

// By using COPYFILE_EXCL, the operation will fail if destination.txt exists.
fs.copyFileSync('source.txt', 'destination.txt', COPYFILE_EXCL);

Related

License

MIT

更新履歴

2018.05.06, v1.1.1

fix:

  • (fs-copy-file-sync) call to closeSync (#1)

feature:

  • (travis) add node v10

2018.05.03, v1.1.0

feature:

  • (fs-copy-file-sync) add support of node v10 masks
  • (package) redrun v6.0.0
  • (package) buble v0.19.2
  • (package) buble v0.18.0
  • (package) buble v0.17.0
  • (package) coveralls v3.0.0
  • (package) buble v0.16.0

2017.09.18, v1.0.1

fix:

  • docs(readme) link