Type:

Default: false

It enables embedded detection over the target url.

When is present, a new iframe data field will be returned when is possible. Any URL that implements

specification is supported.

import mql from '@microlink/mql'

const { data } = await mql('https://www.youtube.com/watch?v=9P6rdqiybaw', {
  iframe: true
})

If the discovery has been done successfully, the iframe field will be now present into the response:

The `iframe` field has `scripts` and `html` subfields.

Additionally, you can supply any consumer query parameter supported by

, like maxWidth or maxHeight:

import mql from '@microlink/mql'

const { data } = await mql('https://www.youtube.com/watch?v=9P6rdqiybaw', {
  iframe: {
    maxWidth: 350
  }
})

Keep in mind the support for this query parameters depend on every provider implementation.

Providers supported

Most of the most popular sites over the Internet supports oEmbed protocol.

A non exhaustive list of supported providers are:

iframe