@reflink/reflink

[![npm version](https://badge.fury.io/js/%40reflink%2Freflink.svg)](https://www.npmjs.com/package/@reflink/reflink) [![Build Status](https://github.com/pnpm/reflink/workflows/CI/badge.svg)](https://github.com/pnpm/reflink/actions)

0.1.14-canary.c18f49b
Source
npm

Version published: 10 months ago

Weekly downloads: 1.5K; increased by9.83%

Maintainers: 1

Weekly downloads

Created: 12 months ago

Source

@reflink/reflink

Copy-on-write file cloning for Node.js, powered by 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 @reflink/reflink using your favorite package manager:

pnpm add @reflink/reflink

Usage

The package provides both synchronous and asynchronous methods to clone files.

TypeScript Usage

First, import the package:

import { reflinkFileSync, reflinkFile } from '@reflink/reflink';

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:

pnpm install
pnpm build
pnpm test

FAQs

What is @reflink/reflink?

Is @reflink/reflink popular?

Is @reflink/reflink well maintained?

Package last updated on 12 Nov 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install