diff options
Diffstat (limited to 'node_modules/clipboardy/readme.md')
| -rw-r--r-- | node_modules/clipboardy/readme.md | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/node_modules/clipboardy/readme.md b/node_modules/clipboardy/readme.md new file mode 100644 index 00000000..1c549785 --- /dev/null +++ b/node_modules/clipboardy/readme.md @@ -0,0 +1,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) |
