Socket
Socket
Sign inDemoInstall

@reflink/reflink

Package Overview
Dependencies
0
Maintainers
1
Versions
15
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@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)


Version published
Maintainers
1
Created

Readme

Source

npm version Build Status

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

Package last updated on 02 Jan 2024

Did you know?

Socket

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

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc