@refclone/refclone
v0.1.5
Published
[![npm version](https://badge.fury.io/js/%40refclone%2Frefclone.svg)](https://www.npmjs.com/package/@refclone/refclone) [![Build Status](https://github.com/nachoaldamav/cross-reflink/workflows/CI/badge.svg)](https://github.com/nachoaldamav/cross-reflink/a
Downloads
3
Readme
@refclone/refclone
Copy-on-write file cloning for Node.js, powered by the NAPI-RS and built upon reflink-copy. This package supports a variety of platforms, including ARM and x86 architectures.
Supported Platforms
- Linux
- MacOS
- Windows (Server 2012+ and Windows Dev Drives)
Installation
Just install @refclone/refclone
using your favorite package manager:
pnpm add @refclone/refclone
Usage
The package provides both synchronous and asynchronous methods to clone files.
TypeScript Usage
First, import the package:
import { reflinkFileSync, reflinkFile } from '@refclone/refclone';
Synchronous Method
reflinkFileSync('source.txt', 'destination.txt');
Asynchronous Method
await reflinkFile('source.txt', 'destination.txt');
Testing
This package is tested using vitest
. You can run the tests locally using:
yarn install
yarn build
yarn test