Browse Source

Change data -> format in clipboard docs

Kevin Sawicki 8 years ago
parent
commit
3ae034deab
1 changed files with 12 additions and 7 deletions
  1. 12 7
      docs/api/clipboard.md

+ 12 - 7
docs/api/clipboard.md

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