diff options
Diffstat (limited to 'includes/external/addressbook/node_modules/open-graph-scraper/dist/index.d.ts')
-rw-r--r-- | includes/external/addressbook/node_modules/open-graph-scraper/dist/index.d.ts | 36 |
1 files changed, 0 insertions, 36 deletions
diff --git a/includes/external/addressbook/node_modules/open-graph-scraper/dist/index.d.ts b/includes/external/addressbook/node_modules/open-graph-scraper/dist/index.d.ts deleted file mode 100644 index ed29970..0000000 --- a/includes/external/addressbook/node_modules/open-graph-scraper/dist/index.d.ts +++ /dev/null @@ -1,36 +0,0 @@ -import type { OpenGraphScraperOptions, OgObject } from './lib/types'; -/** - * `open-graph-scraper` uses [got](https://github.com/sindresorhus/got) for requests and most of - * [got's options](https://github.com/sindresorhus/got/blob/main/documentation/2-options.md) - * should work as `open-graph-scraper` options. - * - * @param {object} options - The options used by Open Graph Scraper - * @param {string} options.url - URL of the site. (Required) - * @param {string} [options.html] - You can pass in an HTML string to run ogs on it. (use without options.url) - * @param {string[]} [options.blacklist] - Pass in an array of sites you don't want ogs to run on. - * @param {boolean} [options.onlyGetOpenGraphInfo] - Only fetch open graph info and don't fall back on anything else. - * @param {boolean} [options.ogImageFallback] - Fetch other images if no open graph ones are found. - * @param {object} [options.customMetaTags] - Here you can define custom meta tags you want to scrape. - * @param {boolean} [options.allMedia] - By default, OGS will only send back the first image/video it finds. - * @param {number | false} [options.downloadLimit] - Maximum size of the content downloaded from the server, in bytes. - * @param {object} [options.ValidatorSettings] - Sets the options used by validator.js for testing the URL - * @param {boolean} [options.decompress] - Set the accept-encoding to `gzip, deflate, br` (default: `true`). - * @param {boolean} [options.followRedirect] - Defines if redirect responses should be followed automatically. (default: `true`). - * @param {Object<string, string>} [options.headers] - An object containing request headers. Useful for setting the user-agent. - * @param {number} [options.maxRedirects] - If exceeded, the request will be aborted and a MaxRedirectsError will be thrown. (default: `10`). - * @param {object} [options.retry] - Number of times `og`s will retry the request (default: `2`). - * @param {object} [options.timeout] - Timeout of the request. - * @returns {Promise} Promise Object with the Open Graph results - */ -export default function run(options: OpenGraphScraperOptions): Promise<ErrorResult | SuccessResult>; -type SuccessResult = { - error: false; - result: OgObject; - response: object; -}; -type ErrorResult = { - error: true; - result: OgObject; - response: undefined; -}; -export {}; |