aboutsummaryrefslogtreecommitdiff
path: root/node_modules/clipboardy/readme.md
diff options
context:
space:
mode:
authorruki <waruqi@gmail.com>2018-11-08 00:38:48 +0800
committerruki <waruqi@gmail.com>2018-11-07 21:53:09 +0800
commit26105034da4fcce7ac883c899d781f016559310d (patch)
treec459a5dc4e3aa0972d9919033ece511ce76dd129 /node_modules/clipboardy/readme.md
parent2c77f00f1a7ecb6c8192f9c16d3b2001b254a107 (diff)
downloadxmake-docs-26105034da4fcce7ac883c899d781f016559310d.tar.gz
xmake-docs-26105034da4fcce7ac883c899d781f016559310d.zip
switch to vuepress
Diffstat (limited to 'node_modules/clipboardy/readme.md')
-rw-r--r--node_modules/clipboardy/readme.md64
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 [![Build Status: macOS & Linux](https://travis-ci.org/sindresorhus/clipboardy.svg?branch=master)](https://travis-ci.org/sindresorhus/clipboardy) [![Build status: Windows](https://ci.appveyor.com/api/projects/status/gflt3gjn1ia0a3vo/branch/master?svg=true)](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)