ts-open-graph-scraper/lib/types.d.ts

Node.js scraper module for Open Graph and Twitter Card info, based on https://github.com/jshemas/openGraphScraper

import { OptionsWithUrl, FullResponse } from 'request-promise-native';
export declare type IgnoredRequestPromiseProperties = 'callback' | 'json' | 'url';
export declare type OGOptions = Omit<OptionsWithUrl, IgnoredRequestPromiseProperties> & {
    blacklist?: string[];
    html?: string;
    ogImageFallback?: boolean;
    onlyGetOpenGraphInfo?: boolean;
    peekSize?: number;
    protocol?: string | null;
    withCharset?: boolean;
    url?: string;
};
export declare type OGMedia = {
    url: string;
    width: number;
    height: number;
};
export declare type OGVideo = OGMedia & {
    type: string;
};
export declare type OGImage = OGMedia & {
    type: string;
};
export declare type OGMusicSong = {
    url: string;
    track: number;
    disc: number;
};
export declare type OGTwitterImage = OGMedia & {
    alt?: string;
};
export declare type OGTwitterPlayer = OGMedia & {
    stream?: string;
};
export declare type OGDataRaw = {
    [key in OGFields]?: string | string[];
} & {
    charset?: string;
};
export declare type OGData = {
    ogTitle?: string;
    ogType?: string;
    ogUrl?: string;
    ogDescription?: string;
    ogImage?: OGImage[];
    ogVideo?: OGVideo[];
    charset?: string;
    twitterImage?: OGTwitterImage[];
    twitterPlayer?: OGTwitterPlayer[];
    musicSong?: OGMusicSong[];
    response?: FullResponse;
} & Omit<OGDataRaw, 'ogImage' | 'ogVideo' | 'twitterImage' | 'twitterPlayer' | 'musicSong'>;
export declare type OGFields = 'musicAlbum' | 'musicAlbumDisc' | 'musicAlbumTrack' | 'musicCreator' | 'musicDuration' | 'musicMusician' | 'musicReleaseDate' | 'musicSong' | 'musicSongDisc' | 'musicSongTrack' | 'ogAudio' | 'ogAudioSecureURL' | 'ogAudioType' | 'ogAudioURL' | 'ogAvailability' | 'ogDescription' | 'ogDeterminer' | 'ogImage' | 'ogImageHeight' | 'ogImageSecureURL' | 'ogImageType' | 'ogImageURL' | 'ogImageWidth' | 'ogLocale' | 'ogLocaleAlternate' | 'ogPriceAmount' | 'ogPriceCurrency' | 'ogProductAvailability' | 'ogProductCondition' | 'ogProductPriceAmount' | 'ogProductPriceCurrency' | 'ogProductRetailerItemId' | 'ogSiteName' | 'ogTitle' | 'ogType' | 'ogUrl' | 'ogVideo' | 'ogVideo' | 'ogVideoHeight' | 'ogVideoSecureURL' | 'ogVideoType' | 'ogVideoWidth' | 'twitterAppIdGooglePlay' | 'twitterAppIdiPad' | 'twitterAppIdiPhone' | 'twitterAppNameGooglePlay' | 'twitterAppNameiPad' | 'twitterAppNameiPhone' | 'twitterAppUrlGooglePlay' | 'twitterAppUrliPad' | 'twitterAppUrliPhone' | 'twitterCard' | 'twitterCreator' | 'twitterCreatorId' | 'twitterDescription' | 'twitterImage' | 'twitterImageAlt' | 'twitterImageHeight' | 'twitterImageSrc' | 'twitterImageWidth' | 'twitterPlayer' | 'twitterPlayerHeight' | 'twitterPlayerStream' | 'twitterPlayerWidth' | 'twitterSite' | 'twitterSiteId' | 'twitterTitle' | 'videoActor' | 'videoActorRole' | 'videoDirector' | 'videoWriter' | 'videoDuration' | 'videoReleaseDate' | 'videoTag' | 'videoSeries' | 'articlePublishedTime' | 'articleModifiedTime' | 'articleExpirationTime' | 'articleAuthor' | 'articlePublishedTime' | 'articleTag' | 'bookAuthor' | 'bookTag' | 'bookIsbn' | 'bookReleaseDate' | 'profileFirstName' | 'profileLastName' | 'profileUsername' | 'profileGender' | 'author' | 'keywords' | 'description' | 'copyright' | 'applicationName';