mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

Change data -> format in clipboard docs

Browse source
This commit is contained in:
Kevin Sawicki 2017-03-16 15:45:41 -07:00
parent ab05346572
commit 3ae034deab
1 changed files with 12 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
docs/api/clipboard.md
View file

@ -133,24 +133,29 @@ Clears the clipboard content.
Returns `String[]` - An array of supported formats for the clipboard `type`. Returns `String[]` - An array of supported formats for the clipboard `type`.
### `clipboard.has(data[, type])` _Experimental_ ### `clipboard.has(format[, type])` _Experimental_
* `data` String * `format` String
* `type` String (optional) * `type` String (optional)
Returns `Boolean` - Whether the clipboard supports the format of specified `data`. Returns `Boolean` - Whether the clipboard supports the specified `format`.
```javascript ```javascript
const {clipboard} = require('electron') const {clipboard} = require('electron')
console.log(clipboard.has('<p>selection</p>')) console.log(clipboard.has('<p>selection</p>'))
``` ```
### `clipboard.read(data[, type])` _Experimental_ ### `clipboard.read(format)` _Experimental_
* `data` String * `format` String
* `type` String (optional)
Returns `String` - Reads `data` from the clipboard. Returns `String` - Reads `format` type from the clipboard.
### `clipboard.readBuffer(format)` _Experimental_
* `format` String
Returns `Buffer` - Reads `format` type from the clipboard.
### `clipboard.write(data[, type])` ### `clipboard.write(data[, type])`