import URLEmbedProvider from 'url-embed/lib/classes/URLEmbedProvider.js'

public interface | source

URLEmbedProvider

Converts a pattern of URLs into markup

Constructor Summary

Public Constructor
public	constructor(urlPatterns: Array<RegExp>)

Public Members
public	urlPatterns: *

Public Methods
public	configure(engineOptions: Object) Stub method caled by EmbedEngine.
public	errorMarkup(embed: Embed): * Returns markup if an error occurs resolving the embed
public	filterData(data: {html: String}) Can be overridden/replaced to modify a specific provider's data before it is passed to the client callback.
public	getEmbed(embed: Embed, callback: function(error: Error, data: Object)) Resolves options.embedURL to an embed and passes it to callback.
public	isMatch(embedURL: String): boolean Determines if a given URL matches this provider

Name	Type	Attribute	Description
urlPatterns	Array<RegExp>		array of regular expressions that this provider will match

Stub method caled by EmbedEngine. Can be overridden.

Name	Type	Attribute	Description
engineOptions	Object

Returns markup if an error occurs resolving the embed

Name	Type	Attribute	Description
embed	Embed		Embed object

Can be overridden/replaced to modify a specific provider's data before it is passed to the client callback.

Name	Type	Attribute	Description
data	{html: String}		Data object containing embed html

Resolves options.embedURL to an embed and passes it to callback.

Name	Type	Attribute	Description
embed	Embed		Embed object
callback	function(error: Error, data: Object)		callback to invoke after resolving embed

Determines if a given URL matches this provider

Name	Type	Attribute	Description
embedURL	String		URL to embed