Socket
Socket
Sign inDemoInstall

clipboardy

Package Overview
Dependencies
21
Maintainers
1
Versions
21
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    clipboardy

Access the system clipboard (copy/paste)


Version published
Weekly downloads
3.9M
decreased by-0.1%
Maintainers
1
Install size
1.18 MB
Created
Weekly downloads
 

Package description

What is clipboardy?

The clipboardy npm package allows for copying to and pasting from the system clipboard in Node.js applications. It provides a simple interface to interact with the clipboard on different operating systems.

What are clipboardy's main functionalities?

Copy text to clipboard

This feature allows you to copy text to the system clipboard. The `writeSync` method is used to synchronously write text to the clipboard.

const clipboardy = require('clipboardy');
clipboardy.writeSync('Text to copy');

Paste text from clipboard

This feature allows you to paste text from the system clipboard. The `readSync` method is used to synchronously read text from the clipboard and store it in a variable.

const clipboardy = require('clipboardy');
let text = clipboardy.readSync();
console.log(text);

Copy text to clipboard asynchronously

This feature allows you to copy text to the clipboard asynchronously. The `write` method returns a promise that resolves when the text has been copied.

const clipboardy = require('clipboardy');
clipboardy.write('Text to copy').then(() => {
  console.log('Text copied!');
}).catch(err => {
  console.error('Failed to copy text:', err);
});

Paste text from clipboard asynchronously

This feature allows you to paste text from the clipboard asynchronously. The `read` method returns a promise that resolves with the text from the clipboard.

const clipboardy = require('clipboardy');
clipboardy.read().then(text => {
  console.log('Pasted text:', text);
}).catch(err => {
  console.error('Failed to paste text:', err);
});

Other packages similar to clipboardy

Readme

Source

clipboardy

Access the system clipboard (copy/paste)

Cross-platform. Supports: macOS, Windows, Linux, OpenBSD, FreeBSD, Android with Termux, and modern browsers.

Install

npm install clipboardy

Usage

import clipboard from 'clipboardy';

clipboard.writeSync('🦄');

clipboard.readSync();
//=> '🦄'

API

In the browser, it requires a secure context.

clipboard

.write(text)

Write (copy) to the clipboard asynchronously.

Returns a Promise.

text

Type: string

The text to write to the clipboard.

.read()

Read (paste) from the clipboard asynchronously.

Returns a Promise.

.writeSync(text)

Write (copy) to the clipboard synchronously.

Doesn't work in browsers.

text

Type: string

The text to write to the clipboard.

.readSync()

Read (paste) from the clipboard synchronously.

Doesn't work in browsers.

FAQ

Where can I find the source of the bundled binaries?

The Linux binary is just a bundled version of xsel. The source for the Windows binary can be found here.

Keywords

FAQs

Last updated on 23 Oct 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

Related posts

SocketSocket SOC 2 Logo

Product

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

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc