copy-node

copy-node

A simple Node.js library for clipboard operations across different platforms.

Features

• Cross-platform clipboard support (macOS, Windows, Linux)
• Easy-to-use Promise-based API
• No external dependencies
• TypeScript support with full type definitions
• Supports both CommonJS and ES Modules

Installation

npm install copy-node

Usage

ES Modules (Recommended)

import { copy } from 'copy-node';

// Copy text to clipboard
await copy('Hello, World!');

// Copy variables or complex strings
const text = 'This text will be copied to clipboard';
await copy(text);

CommonJS

const { copy } = require('copy-node');

// Copy text to clipboard
copy('Hello, World!').then(() => {
  console.log('Text copied to clipboard');
}).catch((error) => {
  console.error('Failed to copy text:', error.message);
});

Platform Requirements

macOS

• Built-in support via pbcopy

Windows

• Built-in support via clip

Linux

• Requires either xclip or xsel to be installed
• The library will automatically try both tools as fallback

Installing clipboard utilities on Linux

Ubuntu/Debian:

# For xclip
sudo apt-get install xclip

# Or for xsel
sudo apt-get install xsel

CentOS/RHEL/Fedora:

# For xclip
sudo yum install xclip
# or on newer versions
sudo dnf install xclip

# Or for xsel
sudo yum install xsel
# or on newer versions
sudo dnf install xsel

API

copy(text: string): Promise<void>

Copies the provided text to the system clipboard.

Parameters:

• text - The string to copy to clipboard

Returns:

• A Promise that resolves when the copy operation completes successfully

Throws:

• Error if the operation fails or platform is unsupported

Supported Platforms

• macOS (darwin)
• Windows (win32)
• Linux (requires xclip or xsel)

Example

const { copy } = require('copy-node');

async function example() {
  try {
    await copy('Hello from copy-node!');
    console.log('Text copied to clipboard successfully!');
  } catch (error) {
    console.error('Failed to copy text:', error.message);
  }
}

example();

License

MIT