@social-embed/lib
#
Enumerations#
Type aliases#
ProviderKeyƬ ProviderKey: keyof typeof Provider
#
Defined in#
ProviderTypeƬ ProviderType: typeof Provider
[Provider
]
#
Defined in#
Variables#
ProviderIdFunctionMap• Const
ProviderIdFunctionMap: { [P in ValueOfProvider]: function}
#
Defined in#
ProviderIdUrlFunctionMap• Const
ProviderIdUrlFunctionMap: { [P in ValueOfProvider]: function}
#
Defined in#
dailyMotionUrlRegex• Const
dailyMotionUrlRegex: RegExp
#
Defined in#
edPuzzleUrlRegex• Const
edPuzzleUrlRegex: RegExp
Matches ID from URLs matching: https://edpuzzle.com/media/606b413369971e424ec6021e
#
Defined in#
genericUrlRegex• Const
genericUrlRegex: RegExp
#
Defined in#
loomUrlRegex• Const
loomUrlRegex: RegExp
Matches ID from URLs matching: https://www.loom.com/share/e883f70b219a49f6ba7fbeac71a72604
#
Defined in#
spotifySymbolRegex• Const
spotifySymbolRegex: RegExp
#
Defined in#
spotifyUrlRegex• Const
spotifyUrlRegex: RegExp
#
Defined in#
vimeoUrlRegex• Const
vimeoUrlRegex: RegExp
#
Defined in#
wistiaUrlRegex• Const
wistiaUrlRegex: RegExp
Matches ID from URLs matching:
While these are not used, these are mentions on Wistia's embed construction docs:
#
Defined in#
youTubeUrlRegex• Const
youTubeUrlRegex: "^(?:(?:https?):)?(?://)?[^/]*(?:youtube(?:-nocookie)?.com|youtu.be).*[=/]([-\\w]{11})(?:\\?|=|&|$)"
Regex matcher for YouTube URLs
#
Defined in#
Functions#
convertUrlToEmbedUrl▸ Const
convertUrlToEmbedUrl(url
): string
Converts URL variations from sites to their "embed-friendly" URL.
#
ParametersName | Type |
---|---|
url | string |
#
Returnsstring
#
Defined in#
getDailyMotionEmbedFromId▸ Const
getDailyMotionEmbedFromId(dailyMotionId
): string
#
ParametersName | Type |
---|---|
dailyMotionId | string |
#
Returnsstring
#
Defined in#
getDailyMotionIdFromUrl▸ Const
getDailyMotionIdFromUrl(url
): string
#
ParametersName | Type |
---|---|
url | string |
#
Returnsstring
#
Defined in#
getEdPuzzleEmbedUrlFromId▸ Const
getEdPuzzleEmbedUrlFromId(edPuzzleId
): string
Return embed-friendly URL from ID.
#
ParametersName | Type | Description |
---|---|---|
edPuzzleId | string | ID of embed |
#
Returnsstring
#
Defined in#
getEdPuzzleIdFromUrl▸ Const
getEdPuzzleIdFromUrl(url
): string
Return ID from shared link.
#
ParametersName | Type | Description |
---|---|---|
url | string | Shared URL link. |
#
Returnsstring
#
Defined in#
getLoomEmbedUrlFromId▸ Const
getLoomEmbedUrlFromId(loomId
): string
Return embed-friendly URL from ID.
#
ParametersName | Type | Description |
---|---|---|
loomId | string | ID of embed |
#
Returnsstring
#
Defined in#
getLoomIdFromUrl▸ Const
getLoomIdFromUrl(url
): string
Return ID from shared link.
#
ParametersName | Type | Description |
---|---|---|
url | string | Shared URL link. |
#
Returnsstring
#
Defined in#
getProviderFromUrl▸ Const
getProviderFromUrl(url
): Provider
#
ParametersName | Type |
---|---|
url | string |
#
Returns#
Defined in#
getSpotifyEmbedUrlFromIdAndType▸ Const
getSpotifyEmbedUrlFromIdAndType(spotifyId
, spotifyType
): string
#
ParametersName | Type |
---|---|
spotifyId | string |
spotifyType | string |
#
Returnsstring
#
Defined in#
getSpotifyIdAndTypeFromUrl▸ Const
getSpotifyIdAndTypeFromUrl(url
): [string
, string
]
#
ParametersName | Type |
---|---|
url | string |
#
Returns[string
, string
]
#
Defined in#
getVimeoEmbedUrlFromId▸ Const
getVimeoEmbedUrlFromId(vimeoId
): string
#
ParametersName | Type |
---|---|
vimeoId | string |
#
Returnsstring
#
Defined in#
getVimeoIdFromUrl▸ Const
getVimeoIdFromUrl(url
): string
#
ParametersName | Type |
---|---|
url | string |
#
Returnsstring
#
Defined in#
getWistiaEmbedUrlFromId▸ Const
getWistiaEmbedUrlFromId(wistiaId
): string
Return embed-friendly URL from ID.
#
ParametersName | Type | Description |
---|---|---|
wistiaId | string | ID of embed |
#
Returnsstring
#
Defined in#
getWistiaIdFromUrl▸ Const
getWistiaIdFromUrl(url
): string
Return ID from shared link.
#
ParametersName | Type | Description |
---|---|---|
url | string | Shared URL link. |
#
Returnsstring
#
Defined in#
getYouTubeEmbedUrlFromId▸ Const
getYouTubeEmbedUrlFromId(youtubeID
): string
#
ParametersName | Type |
---|---|
youtubeID | string |
#
Returnsstring
#
Defined in#
getYouTubeIdFromUrl▸ Const
getYouTubeIdFromUrl(url
): string
#
ParametersName | Type |
---|---|
url | string |
#
Returnsstring
#
Defined in#
isValidUrl▸ Const
isValidUrl(value
): boolean
#
ParametersName | Type |
---|---|
value | string |
#
Returnsboolean