-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
28 changed files
with
11,171 additions
and
25,450 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| // Type definitions for oembed-parser | ||
| // Project: https://www.npmjs.com/package/oembed-parser | ||
| // Definitions by: BendingBender <https://github.com/BendingBender> | ||
| // CodeBast4rd <https://github.com/CodeBast4rd> | ||
| // Marc McIntosh <https://github.com/MarcMcIntosh> | ||
| // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped | ||
|
|
||
| export function extract(url: string, params?: any): Promise<OembedData>; | ||
|
|
||
| export function hasProvider(url: string): boolean | ||
|
|
||
| export function findProvider(url: string): FindProviderResult | ||
|
|
||
| export function setProviderList(providers: Provider[]): void | ||
|
|
||
| export interface Endpoint { | ||
| schemes?: string[]; | ||
| url: string; | ||
| formats?: string[]; // "json" "xml" | ||
| discovery?: boolean; | ||
| } | ||
|
|
||
| export interface Provider { | ||
| "provider_name": string; | ||
| "provider_url": string; | ||
| "endpoints": Endpoint[]; | ||
| } | ||
|
|
||
| export interface FindProviderResult { | ||
| "fetchEndpoint": string; | ||
| "provider_name": string; | ||
| "provider_url": string; | ||
| } | ||
|
|
||
| /** | ||
| * Basic data structure of every oembed response see https://oembed.com/ | ||
| */ | ||
| export interface OembedData { | ||
| type: 'rich' | 'video' | 'photo' | 'link'; | ||
| version: string; | ||
| /** A text title, describing the resource. */ | ||
| title?: string; | ||
| /** The name of the author/owner of the resource. */ | ||
| author_name?: string; | ||
| /** A URL for the author/owner of the resource. */ | ||
| author_url?: string; | ||
| /** The name of the resource provider. */ | ||
| provider_name?: string; | ||
| /** The url of the resource provider. */ | ||
| provider_url?: string; | ||
| /** The suggested cache lifetime for this resource, in seconds. Consumers may choose to use this value or not. */ | ||
| cache_age?: string | number; | ||
| /** | ||
| * A URL to a thumbnail image representing the resource. | ||
| * The thumbnail must respect any maxwidth and maxheight parameters. | ||
| * If this parameter is present, thumbnail_width and thumbnail_height must also be present. | ||
| */ | ||
| thumbnail_url?: string; | ||
| /** | ||
| * The width of the optional thumbnail. | ||
| * If this parameter is present, thumbnail_url and thumbnail_height must also be present. | ||
| */ | ||
| thumbnail_width?: number; | ||
| /** | ||
| * The height of the optional thumbnail. | ||
| * If this parameter is present, thumbnail_url and thumbnail_width must also be present. | ||
| */ | ||
| thumbnail_height?: number; | ||
| } | ||
|
|
||
| export interface LinkTypeData extends OembedData { | ||
| readonly type: 'link'; | ||
| } | ||
|
|
||
| export interface PhotoTypeData extends OembedData { | ||
| readonly type: 'photo'; | ||
| /** | ||
| * The source URL of the image. Consumers should be able to insert this URL into an <img> element. | ||
| * Only HTTP and HTTPS URLs are valid. | ||
| */ | ||
| url: string; | ||
| /** The width in pixels of the image specified in the url parameter. */ | ||
| width: number; | ||
| /** The height in pixels of the image specified in the url parameter. */ | ||
| height: number; | ||
| } | ||
|
|
||
| export interface VideoTypeData extends OembedData { | ||
| readonly type: 'video'; | ||
| /** | ||
| * The HTML required to embed a video player. | ||
| * The HTML should have no padding or margins. | ||
| * Consumers may wish to load the HTML in an off-domain iframe to avoid XSS vulnerabilities. | ||
| */ | ||
| html: string; | ||
| /** The width in pixels required to display the HTML. */ | ||
| width: number; | ||
| /** The height in pixels required to display the HTML. */ | ||
| height: number; | ||
| } | ||
|
|
||
| export interface RichTypeData extends OembedData { | ||
| readonly type: 'rich'; | ||
| /** | ||
| * The HTML required to display the resource. | ||
| * The HTML should have no padding or margins. | ||
| * Consumers may wish to load the HTML in an off-domain iframe to avoid XSS vulnerabilities. | ||
| * The markup should be valid XHTML 1.0 Basic. | ||
| */ | ||
| html: string; | ||
| /** The width in pixels required to display the HTML. */ | ||
| width: number; | ||
| /** The height in pixels required to display the HTML. */ | ||
| height: number; | ||
| } |
Oops, something went wrong.