ClipboardItem: getType() method
Baseline 2024
Newly available
Since June 2024, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The getType()
method of the ClipboardItem
interface returns a Promise
that resolves with a Blob
of the requested MIME type or an error if the MIME type is not found.
Syntax
getType(type)
Parameters
Return value
Exceptions
NotFoundError
DOMException
-
The
type
does not match a known MIME type. TypeError
-
No parameter is specified or the
type
is not that of theClipboardItem
.
Examples
In the following example, we're returning all items on the clipboard via the clipboard.read()
method.
Then utilizing the ClipboardItem.types
property to set the getType()
argument and return the corresponding blob object.
async function getClipboardContents() {
try {
const clipboardItems = await navigator.clipboard.read();
for (const clipboardItem of clipboardItems) {
for (const type of clipboardItem.types) {
const blob = await clipboardItem.getType(type);
// we can now use blob here
}
}
} catch (err) {
console.error(err.name, err.message);
}
}
Specifications
Specification |
---|
Clipboard API and events # dom-clipboarditem-gettype |
Browser compatibility
BCD tables only load in the browser