# node-clipboardy

> Access the system clipboard (copy/paste). For node only:)

Latest version **1.0.3** (published 2022-03-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install node-clipboardy
pnpm add node-clipboardy
yarn add node-clipboardy
bun add node-clipboardy
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2022-03-12 |
| First published | 2022-03-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | ^12.20.0 \|\| ^14.13.1 \|\| >=16.0.0 |
| Dependencies | 3 |
| Unpacked size | 891.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Atageldi Soyenjov |
| Maintainers | atageldi194229 |
| Keywords | clipboard, copy, paste, copy-paste, pasteboard, read, write, pbcopy, clip, xclip, xsel |

## Links

- npm: https://www.npmjs.com/package/node-clipboardy
- Repository: https://github.com/atageldi194229/node-clipboardy
- Homepage: https://github.com/atageldi194229/node-clipboardy#readme
- Issues: https://github.com/atageldi194229/node-clipboardy/issues
- npm.io page: https://npm.io/package/node-clipboardy

## Dependencies (3)

- [arch](https://npm.io/package/arch.md) ^2.2.0
- [execa](https://npm.io/package/execa.md) ^5.1.1
- [is-wsl](https://npm.io/package/is-wsl.md) ^2.2.0

## Alternatives

- [csv-to-markdown-table](https://npm.io/package/csv-to-markdown-table.md) — 47.0K weekly downloads
- [@sapphire/ratelimits](https://npm.io/package/@sapphire/ratelimits.md) — 4.4K weekly downloads
- [js-csvparser](https://npm.io/package/js-csvparser.md) — 2.0K weekly downloads
- [@adadapted/js-sdk](https://npm.io/package/@adadapted/js-sdk.md) — 251 weekly downloads
- [@grapecity/spread-sheets-sparklines](https://npm.io/package/@grapecity/spread-sheets-sparklines.md) — 103 weekly downloads

## Recent versions

- 1.0.3 (latest) — 2022-03-12
- 1.0.2 — 2022-03-12
- 1.0.1 — 2022-03-12
- 1.0.0 — 2022-03-12

## README

# node-clipboardy

> Access the system clipboard (copy/paste)

Only for node, and original copied source code: https://github.com/sindresorhus/clipboardy

Cross-platform. Supports: macOS, Windows, Linux, OpenBSD, FreeBSD, Android with [Termux](https://termux.com/).

## Install

```sh
npm install node-clipboardy
```

## Usage

```js
var ncp = require('node-clipboardy');

ncp.writeSync('🦄');

ncp.readSync();
//=> '🦄'
```

## API

### 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.

##### text

Type: `string`

The text to write to the clipboard.

#### .readSync()

Read (paste) from the clipboard synchronously.

---
_Source: https://npm.io/package/node-clipboardy · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._