summaryrefslogtreecommitdiff
path: root/includes/external/addressbook/node_modules/open-graph-scraper/README.md
diff options
context:
space:
mode:
authorRaindropsSys <contact@minteck.org>2023-04-06 22:18:28 +0200
committerRaindropsSys <contact@minteck.org>2023-04-06 22:18:28 +0200
commit83354b2b88218090988dd6e526b0a2505b57e0f1 (patch)
treee3c73c38a122a78bb7e66fbb99056407edd9d4b9 /includes/external/addressbook/node_modules/open-graph-scraper/README.md
parent47b8f2299a483024c4a6a8876af825a010954caa (diff)
downloadpluralconnect-83354b2b88218090988dd6e526b0a2505b57e0f1.tar.gz
pluralconnect-83354b2b88218090988dd6e526b0a2505b57e0f1.tar.bz2
pluralconnect-83354b2b88218090988dd6e526b0a2505b57e0f1.zip
Updated 5 files and added 1110 files (automated)
Diffstat (limited to 'includes/external/addressbook/node_modules/open-graph-scraper/README.md')
-rw-r--r--includes/external/addressbook/node_modules/open-graph-scraper/README.md141
1 files changed, 141 insertions, 0 deletions
diff --git a/includes/external/addressbook/node_modules/open-graph-scraper/README.md b/includes/external/addressbook/node_modules/open-graph-scraper/README.md
new file mode 100644
index 0000000..c2f78df
--- /dev/null
+++ b/includes/external/addressbook/node_modules/open-graph-scraper/README.md
@@ -0,0 +1,141 @@
+# openGraphScraper
+
+[![Node.js CI](https://github.com/jshemas/openGraphScraper/workflows/Node.js%20CI/badge.svg?branch=master)](https://github.com/jshemas/openGraphScraper/actions?query=branch%3Amaster)
+[![Known Vulnerabilities](https://snyk.io/test/github/jshemas/openGraphScraper/badge.svg)](https://snyk.io/test/github/jshemas/openGraphScraper)
+
+A simple node module for scraping Open Graph and Twitter Card info off a site.
+
+Note: `open-graph-scraper` doesn't support browser usage at this time.
+
+## Installation
+
+```bash
+npm install open-graph-scraper --save
+```
+
+## Usage
+
+```javascript
+const ogs = require('open-graph-scraper');
+const options = { url: 'http://ogp.me/' };
+ogs(options)
+ .then((data) => {
+ const { error, result, response } = data;
+ console.log('error:', error); // This returns true or false. True if there was an error. The error itself is inside the results object.
+ console.log('result:', result); // This contains all of the Open Graph results
+ console.log('response:', response); // This contains the HTML of page
+ })
+```
+
+## Results JSON
+
+Check the return for a ```success``` flag. If success is set to true, then the url input was valid. Otherwise it will be set to false. The above example will return something like...
+
+```javascript
+{
+ ogTitle: 'Open Graph protocol',
+ ogType: 'website',
+ ogUrl: 'http://ogp.me/',
+ ogDescription: 'The Open Graph protocol enables any web page to become a rich object in a social graph.',
+ ogImage: {
+ url: 'http://ogp.me/logo.png',
+ width: '300',
+ height: '300',
+ type: 'image/png'
+ },
+ requestUrl: 'http://ogp.me/',
+ success: true
+}
+```
+
+## Options
+
+| Name | Info | Default Value | Required |
+|----------------------|----------------------------------------------------------------------------|---------------|----------|
+| url | URL of the site. | | x |
+| html | You can pass in an HTML string to run ogs on it. (use without options.url) | | |
+| blacklist | Pass in an array of sites you don't want ogs to run on. | [] | |
+| onlyGetOpenGraphInfo | Only fetch open graph info and don't fall back on anything else. | false | |
+| ogImageFallback | Fetch other images if no open graph ones are found. | true | |
+| customMetaTags | Here you can define custom meta tags you want to scrape. | [] | |
+| allMedia | By default, OGS will only send back the first image/video it finds | false | |
+| downloadLimit | Maximum size of the content downloaded from the server, in bytes | 1000000 (1MB) | |
+| urlValidatorSettings | Sets the options used by validator.js for testing the URL | [Here](https://github.com/jshemas/openGraphScraper/blob/master/lib/utils.js#L102-L114) | |
+
+Note: `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.
+
+## Custom Meta Tag Example
+
+```javascript
+const ogs = require('open-graph-scraper');
+const options = {
+ url: 'https://github.com/jshemas/openGraphScraper',
+ customMetaTags: [{
+ multiple: false, // is there more than one of these tags on a page (normally this is false)
+ property: 'hostname', // meta tag name/property attribute
+ fieldName: 'hostnameMetaTag', // name of the result variable
+ }],
+};
+ogs(options)
+ .then((data) => {
+ const { error, result, response } = data;
+ console.log('hostnameMetaTag:', result.hostnameMetaTag); // hostnameMetaTag: github.com
+ })
+```
+
+## Proxy Example
+
+[Look here](https://github.com/sindresorhus/got/blob/main/documentation/tips.md#proxying) for more info on how to use proxies.
+
+```javascript
+const ogs = require('open-graph-scraper');
+const tunnel = require('tunnel');
+const options = {
+ url: 'https://whatismyipaddress.com/',
+ timeout: {
+ request: 10000,
+ },
+ agent: {
+ // setting proxy agent for https requests
+ https: tunnel.httpsOverHttp({
+ // test proxies can be found here: https://hidemy.name/en/proxy-list/?country=US&type=h#list or http://free-proxy.cz/en/proxylist/country/US/https/ping/all
+ proxy: {
+ host: 'proxy_ip',
+ port: proxyPort,
+ rejectUnauthorized: false,
+ }
+ })
+ }
+};
+ogs(options)
+ .then((data) => {
+ const { error, result, response } = data;
+ console.log('response:', response); // you should see the proxy IP in here
+ })
+```
+
+## User Agent Example
+
+```javascript
+const ogs = require("open-graph-scraper");
+const options = {
+ url: "https://www.wikipedia.org/",
+ headers: {
+ "user-agent": "Googlebot/2.1 (+http://www.google.com/bot.html)",
+ },
+};
+ogs(options)
+ .then((data) => {
+ const { error, result, response } = data;
+ console.log("error:", error); // This returns true or false. True if there was an error. The error itself is inside the results object.
+ console.log("results:", results); // This contains all of the Open Graph results
+ })
+```
+
+## Tests
+
+Then you can run the tests by running...
+
+```bash
+npm run test
+```