This repository has been archived on 2024-07-27. You can view files and clone it, but cannot push or open issues or pull requests.
keksAccountGUI/node_modulesOLD/clipboardy/readme.md
2019-08-11 20:48:02 +02:00

68 lines
1.2 KiB
Markdown

# clipboardy [![Build Status](https://travis-ci.org/sindresorhus/clipboardy.svg?branch=master)](https://travis-ci.org/sindresorhus/clipboardy)
> Access the system clipboard (copy/paste)
Cross-platform. Supports: macOS, Windows, Linux, OpenBSD, FreeBSD, Android with [Termux](https://termux.com/).
## Install
```
$ npm install clipboardy
```
## Usage
```js
const clipboardy = require('clipboardy');
clipboardy.writeSync('🦄');
clipboardy.readSync();
//=> '🦄'
```
## API
### clipboardy
#### .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.
## Related
- [clipboard-cli](https://github.com/sindresorhus/clipboard-cli) - CLI for this module
- [copy-text-to-clipboard](https://github.com/sindresorhus/copy-text-to-clipboard) - Copy text to the clipboard in the browser
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)