blob: 1c5497852b4e472e14dd30af09474a7692ad4e2a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
# clipboardy [](https://travis-ci.org/sindresorhus/clipboardy) [](https://ci.appveyor.com/project/sindresorhus/clipboardy/branch/master)
> 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(input)
Write (copy) to the clipboard asynchronously. Returns a `Promise`.
##### input
Type: `string`
#### .read()
Read (paste) from the clipboard asynchronously. Returns a `Promise`.
#### .writeSync(input)
Write (copy) to the clipboard synchronously.
##### input
Type: `string`
#### .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)
|
