ClipboardItem.getType()

Draft

This page is not complete.

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

var blob = clipboardItem.getType(type);

Parameters

type
A valid MIME type.

Return value

A Promise that resolves with a Blob object.

Exceptions

DOMException
The type does not match a known MIME type.
TypeError
No parameter is specified or the type is not that of the ClipboardItem.

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 Status Comment
Clipboard API and events
The definition of 'ClipboardItem' in that specification.
Working Draft Initial definition.

Browser compatibility

BCD tables only load in the browser

See also