@types/open-graph-scraper 4.8.0 → 4.8.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8,7 +8,7 @@ This package contains type definitions for open-graph-scraper (https://github.co
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/open-graph-scraper.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Fri, 21 May 2021 05:31:19 GMT
11
+ * Last updated: Wed, 19 Oct 2022 13:33:07 GMT
12
12
  * Dependencies: [@types/node](https://npmjs.com/package/@types/node)
13
13
  * Global values: none
14
14
 
@@ -9,186 +9,188 @@ import { PassThrough } from 'stream';
9
9
 
10
10
  declare namespace run {
11
11
  interface OpenGraphImage {
12
- height: string;
12
+ // Height and Width can be optional, see doc on
13
+ // https://github.com/jshemas/openGraphScraper/blob/master/lib/media.js
14
+ height?: string;
13
15
  type: string;
14
16
  url: string;
15
- width: string;
17
+ width?: string;
16
18
  }
17
19
 
18
20
  interface OpenGraphProperties {
19
21
  [key: string]: string | undefined;
20
- alAndroidAppName?: string;
21
- alAndroidClass?: string;
22
- alAndroidPackage?: string;
23
- alAndroidUrl?: string;
24
- alIosAppName?: string;
25
- alIosAppStoreId?: string;
26
- alIosUrl?: string;
27
- alIpadAppName?: string;
28
- alIpadAppStoreId?: string;
29
- alIpadUrl?: string;
30
- alIphoneAppName?: string;
31
- alIphoneAppStoreId?: string;
32
- alIphoneUrl?: string;
33
- alWebShouldFallback?: string;
34
- alWebUrl?: string;
35
- alWindowsAppId?: string;
36
- alWindowsAppName?: string;
37
- alWindowsPhoneAppId?: string;
38
- alWindowsPhoneAppName?: string;
39
- alWindowsPhoneUrl?: string;
40
- alWindowsUniversalAppId?: string;
41
- alWindowsUniversalAppName?: string;
42
- alWindowsUniversalUrl?: string;
43
- alWindowsUrl?: string;
44
- articleAuthor?: string;
45
- articleExpirationTime?: string;
46
- articleModifiedTime?: string;
47
- articlePublishedTime?: string;
48
- articlePublisher?: string;
49
- articleSection?: string;
50
- articleTag?: string;
51
- author?: string;
52
- bookAuthor?: string;
53
- bookCanonicalName?: string;
54
- bookIsbn?: string;
55
- bookReleaseDate?: string;
56
- booksBook?: string;
57
- booksRatingScale?: string;
58
- booksRatingValue?: string;
59
- bookTag?: string;
60
- businessContactDataCountryName?: string;
61
- businessContactDataLocality?: string;
62
- businessContactDataPostalCode?: string;
63
- businessContactDataRegion?: string;
64
- businessContactDataStreetAddress?: string;
65
- dcContributor?: string;
66
- dcCoverage?: string;
67
- dcCreator?: string;
68
- dcDate?: string;
69
- dcDateCreated?: string;
70
- dcDateIssued?: string;
71
- dcDescription?: string;
72
- dcFormatMedia?: string;
73
- dcFormatSize?: string;
74
- dcIdentifier?: string;
75
- dcLanguage?: string;
76
- dcPublisher?: string;
77
- dcRelation?: string;
78
- dcRights?: string;
79
- dcSource?: string;
80
- dcSubject?: string;
81
- dcTitle?: string;
82
- dcType?: string;
83
- modifiedTime?: string;
84
- musicAlbum?: string;
85
- musicAlbumDisc?: string;
86
- musicAlbumTrack?: string;
87
- musicAlbumUrl?: string;
88
- musicCreator?: string;
89
- musicDuration?: string;
90
- musicMusician?: string;
91
- musicReleaseDate?: string;
92
- musicSong?: string;
93
- musicSongDisc?: string;
94
- musicSongTrack?: string;
95
- musicSongUrl?: string;
96
- ogArticleAuthor?: string;
97
- ogArticleExpirationTime?: string;
98
- ogArticleModifiedTime?: string;
99
- ogArticlePublishedTime?: string;
100
- ogArticlePublisher?: string;
101
- ogArticleSection?: string;
102
- ogArticleTag?: string;
103
- ogAudio?: string;
104
- ogAudioSecureURL?: string;
105
- ogAudioType?: string;
106
- ogAudioURL?: string;
107
- ogAvailability?: string;
108
- ogDate?: string;
109
- ogDescription?: string;
110
- ogDeterminer?: string;
111
- ogImage?: string;
112
- ogImageHeight?: string;
113
- ogImageSecureURL?: string;
114
- ogImageType?: string;
115
- ogImageURL?: string;
116
- ogImageWidth?: string;
117
- ogLocale?: string;
118
- ogLocaleAlternate?: string;
119
- ogLogo?: string;
120
- ogPriceAmount?: string;
121
- ogPriceCurrency?: string;
122
- ogProductAvailability?: string;
123
- ogProductCondition?: string;
124
- ogProductPriceAmount?: string;
125
- ogProductPriceCurrency?: string;
126
- ogProductRetailerItemId?: string;
127
- ogSiteName?: string;
128
- ogTitle?: string;
129
- ogType?: string;
130
- ogUrl?: string;
131
- ogVideo?: string;
132
- ogVideoActorId?: string;
133
- ogVideoHeight?: string;
134
- ogVideoSecureURL?: string;
135
- ogVideoType?: string;
136
- ogVideoWidth?: string;
137
- placeLocationLatitude?: string;
138
- placeLocationLongitude?: string;
139
- profileFirstName?: string;
140
- profileGender?: string;
141
- profileLastName?: string;
142
- profileUsername?: string;
143
- publishedTime?: string;
144
- releaseDate?: string;
145
- restaurantContactInfoCountryName?: string;
146
- restaurantContactInfoEmail?: string;
147
- restaurantContactInfoLocality?: string;
148
- restaurantContactInfoPhoneNumber?: string;
149
- restaurantContactInfoPostalCode?: string;
150
- restaurantContactInfoRegion?: string;
151
- restaurantContactInfoStreetAddress?: string;
152
- restaurantContactInfoWebsite?: string;
153
- restaurantMenu?: string;
154
- restaurantRestaurant?: string;
155
- restaurantSection?: string;
156
- restaurantVariationPriceAmount?: string;
157
- restaurantVariationPriceCurrency?: string;
158
- twitterAppIdGooglePlay?: string;
159
- twitterAppIdiPad?: string;
160
- twitterAppIdiPhone?: string;
161
- twitterAppNameGooglePlay?: string;
162
- twitterAppNameiPad?: string;
163
- twitterAppNameiPhone?: string;
164
- twitterAppUrlGooglePlay?: string;
165
- twitterAppUrliPad?: string;
166
- twitterAppUrliPhone?: string;
167
- twitterCard?: string;
168
- twitterCreator?: string;
169
- twitterCreatorId?: string;
170
- twitterDescription?: string;
171
- twitterImage?: string;
172
- twitterImageAlt?: string;
173
- twitterImageHeight?: string;
174
- twitterImageSrc?: string;
175
- twitterImageWidth?: string;
176
- twitterPlayer?: string;
177
- twitterPlayerHeight?: string;
178
- twitterPlayerStream?: string;
179
- twitterPlayerStreamContentType?: string;
180
- twitterPlayerWidth?: string;
181
- twitterSite?: string;
182
- twitterSiteId?: string;
183
- twitterTitle?: string;
184
- twitterUrl?: string;
185
- updatedTime?: string;
22
+ alAndroidAppName?: string | undefined;
23
+ alAndroidClass?: string | undefined;
24
+ alAndroidPackage?: string | undefined;
25
+ alAndroidUrl?: string | undefined;
26
+ alIosAppName?: string | undefined;
27
+ alIosAppStoreId?: string | undefined;
28
+ alIosUrl?: string | undefined;
29
+ alIpadAppName?: string | undefined;
30
+ alIpadAppStoreId?: string | undefined;
31
+ alIpadUrl?: string | undefined;
32
+ alIphoneAppName?: string | undefined;
33
+ alIphoneAppStoreId?: string | undefined;
34
+ alIphoneUrl?: string | undefined;
35
+ alWebShouldFallback?: string | undefined;
36
+ alWebUrl?: string | undefined;
37
+ alWindowsAppId?: string | undefined;
38
+ alWindowsAppName?: string | undefined;
39
+ alWindowsPhoneAppId?: string | undefined;
40
+ alWindowsPhoneAppName?: string | undefined;
41
+ alWindowsPhoneUrl?: string | undefined;
42
+ alWindowsUniversalAppId?: string | undefined;
43
+ alWindowsUniversalAppName?: string | undefined;
44
+ alWindowsUniversalUrl?: string | undefined;
45
+ alWindowsUrl?: string | undefined;
46
+ articleAuthor?: string | undefined;
47
+ articleExpirationTime?: string | undefined;
48
+ articleModifiedTime?: string | undefined;
49
+ articlePublishedTime?: string | undefined;
50
+ articlePublisher?: string | undefined;
51
+ articleSection?: string | undefined;
52
+ articleTag?: string | undefined;
53
+ author?: string | undefined;
54
+ bookAuthor?: string | undefined;
55
+ bookCanonicalName?: string | undefined;
56
+ bookIsbn?: string | undefined;
57
+ bookReleaseDate?: string | undefined;
58
+ booksBook?: string | undefined;
59
+ booksRatingScale?: string | undefined;
60
+ booksRatingValue?: string | undefined;
61
+ bookTag?: string | undefined;
62
+ businessContactDataCountryName?: string | undefined;
63
+ businessContactDataLocality?: string | undefined;
64
+ businessContactDataPostalCode?: string | undefined;
65
+ businessContactDataRegion?: string | undefined;
66
+ businessContactDataStreetAddress?: string | undefined;
67
+ dcContributor?: string | undefined;
68
+ dcCoverage?: string | undefined;
69
+ dcCreator?: string | undefined;
70
+ dcDate?: string | undefined;
71
+ dcDateCreated?: string | undefined;
72
+ dcDateIssued?: string | undefined;
73
+ dcDescription?: string | undefined;
74
+ dcFormatMedia?: string | undefined;
75
+ dcFormatSize?: string | undefined;
76
+ dcIdentifier?: string | undefined;
77
+ dcLanguage?: string | undefined;
78
+ dcPublisher?: string | undefined;
79
+ dcRelation?: string | undefined;
80
+ dcRights?: string | undefined;
81
+ dcSource?: string | undefined;
82
+ dcSubject?: string | undefined;
83
+ dcTitle?: string | undefined;
84
+ dcType?: string | undefined;
85
+ modifiedTime?: string | undefined;
86
+ musicAlbum?: string | undefined;
87
+ musicAlbumDisc?: string | undefined;
88
+ musicAlbumTrack?: string | undefined;
89
+ musicAlbumUrl?: string | undefined;
90
+ musicCreator?: string | undefined;
91
+ musicDuration?: string | undefined;
92
+ musicMusician?: string | undefined;
93
+ musicReleaseDate?: string | undefined;
94
+ musicSong?: string | undefined;
95
+ musicSongDisc?: string | undefined;
96
+ musicSongTrack?: string | undefined;
97
+ musicSongUrl?: string | undefined;
98
+ ogArticleAuthor?: string | undefined;
99
+ ogArticleExpirationTime?: string | undefined;
100
+ ogArticleModifiedTime?: string | undefined;
101
+ ogArticlePublishedTime?: string | undefined;
102
+ ogArticlePublisher?: string | undefined;
103
+ ogArticleSection?: string | undefined;
104
+ ogArticleTag?: string | undefined;
105
+ ogAudio?: string | undefined;
106
+ ogAudioSecureURL?: string | undefined;
107
+ ogAudioType?: string | undefined;
108
+ ogAudioURL?: string | undefined;
109
+ ogAvailability?: string | undefined;
110
+ ogDate?: string | undefined;
111
+ ogDescription?: string | undefined;
112
+ ogDeterminer?: string | undefined;
113
+ ogImage?: string | undefined;
114
+ ogImageHeight?: string | undefined;
115
+ ogImageSecureURL?: string | undefined;
116
+ ogImageType?: string | undefined;
117
+ ogImageURL?: string | undefined;
118
+ ogImageWidth?: string | undefined;
119
+ ogLocale?: string | undefined;
120
+ ogLocaleAlternate?: string | undefined;
121
+ ogLogo?: string | undefined;
122
+ ogPriceAmount?: string | undefined;
123
+ ogPriceCurrency?: string | undefined;
124
+ ogProductAvailability?: string | undefined;
125
+ ogProductCondition?: string | undefined;
126
+ ogProductPriceAmount?: string | undefined;
127
+ ogProductPriceCurrency?: string | undefined;
128
+ ogProductRetailerItemId?: string | undefined;
129
+ ogSiteName?: string | undefined;
130
+ ogTitle?: string | undefined;
131
+ ogType?: string | undefined;
132
+ ogUrl?: string | undefined;
133
+ ogVideo?: string | undefined;
134
+ ogVideoActorId?: string | undefined;
135
+ ogVideoHeight?: string | undefined;
136
+ ogVideoSecureURL?: string | undefined;
137
+ ogVideoType?: string | undefined;
138
+ ogVideoWidth?: string | undefined;
139
+ placeLocationLatitude?: string | undefined;
140
+ placeLocationLongitude?: string | undefined;
141
+ profileFirstName?: string | undefined;
142
+ profileGender?: string | undefined;
143
+ profileLastName?: string | undefined;
144
+ profileUsername?: string | undefined;
145
+ publishedTime?: string | undefined;
146
+ releaseDate?: string | undefined;
147
+ restaurantContactInfoCountryName?: string | undefined;
148
+ restaurantContactInfoEmail?: string | undefined;
149
+ restaurantContactInfoLocality?: string | undefined;
150
+ restaurantContactInfoPhoneNumber?: string | undefined;
151
+ restaurantContactInfoPostalCode?: string | undefined;
152
+ restaurantContactInfoRegion?: string | undefined;
153
+ restaurantContactInfoStreetAddress?: string | undefined;
154
+ restaurantContactInfoWebsite?: string | undefined;
155
+ restaurantMenu?: string | undefined;
156
+ restaurantRestaurant?: string | undefined;
157
+ restaurantSection?: string | undefined;
158
+ restaurantVariationPriceAmount?: string | undefined;
159
+ restaurantVariationPriceCurrency?: string | undefined;
160
+ twitterAppIdGooglePlay?: string | undefined;
161
+ twitterAppIdiPad?: string | undefined;
162
+ twitterAppIdiPhone?: string | undefined;
163
+ twitterAppNameGooglePlay?: string | undefined;
164
+ twitterAppNameiPad?: string | undefined;
165
+ twitterAppNameiPhone?: string | undefined;
166
+ twitterAppUrlGooglePlay?: string | undefined;
167
+ twitterAppUrliPad?: string | undefined;
168
+ twitterAppUrliPhone?: string | undefined;
169
+ twitterCard?: string | undefined;
170
+ twitterCreator?: string | undefined;
171
+ twitterCreatorId?: string | undefined;
172
+ twitterDescription?: string | undefined;
173
+ twitterImage?: string | undefined;
174
+ twitterImageAlt?: string | undefined;
175
+ twitterImageHeight?: string | undefined;
176
+ twitterImageSrc?: string | undefined;
177
+ twitterImageWidth?: string | undefined;
178
+ twitterPlayer?: string | undefined;
179
+ twitterPlayerHeight?: string | undefined;
180
+ twitterPlayerStream?: string | undefined;
181
+ twitterPlayerStreamContentType?: string | undefined;
182
+ twitterPlayerWidth?: string | undefined;
183
+ twitterSite?: string | undefined;
184
+ twitterSiteId?: string | undefined;
185
+ twitterTitle?: string | undefined;
186
+ twitterUrl?: string | undefined;
187
+ updatedTime?: string | undefined;
186
188
  }
187
189
 
188
190
  interface SuccessResult {
189
191
  error: false;
190
192
  result: OpenGraphProperties & {
191
- ogImage?: OpenGraphImage | OpenGraphImage[];
193
+ ogImage?: OpenGraphImage | OpenGraphImage[] | undefined;
192
194
  success: true;
193
195
  };
194
196
  response: PassThrough;
@@ -205,71 +207,71 @@ declare namespace run {
205
207
 
206
208
  interface URLValidatorSettings {
207
209
  /** default is `false`. */
208
- allow_protocol_relative_urls?: boolean;
210
+ allow_protocol_relative_urls?: boolean | undefined;
209
211
  /** default is `false`. */
210
- allow_trailing_dot?: boolean;
212
+ allow_trailing_dot?: boolean | undefined;
211
213
  /** default is `false`. */
212
- allow_underscores?: boolean;
214
+ allow_underscores?: boolean | undefined;
213
215
  /** default is `false`. */
214
- disallow_auth?: boolean;
216
+ disallow_auth?: boolean | undefined;
215
217
  /** default is `false`. */
216
- host_blacklist?: boolean;
218
+ host_blacklist?: boolean | undefined;
217
219
  /** default is `false`. */
218
- host_whitelist?: boolean;
220
+ host_whitelist?: boolean | undefined;
219
221
  /** default is `['http', 'https']`. */
220
- protocols?: string[];
222
+ protocols?: string[] | undefined;
221
223
  /** default is `true`. */
222
- require_host?: boolean;
224
+ require_host?: boolean | undefined;
223
225
  /** default is `false`. */
224
- require_protocol?: boolean;
226
+ require_protocol?: boolean | undefined;
225
227
  /** default is `true`. */
226
- require_tld?: boolean;
228
+ require_tld?: boolean | undefined;
227
229
  /** default is `true`. */
228
- require_valid_protocol?: boolean;
230
+ require_valid_protocol?: boolean | undefined;
229
231
  }
230
232
 
231
233
  interface CustomMetaTag {
232
- multiple?: boolean;
234
+ multiple?: boolean | undefined;
233
235
  property: string;
234
236
  fieldName: string;
235
237
  }
236
238
 
237
239
  interface Options {
238
240
  /** By default, OGS will only send back the first image/video it finds (default: `false`). */
239
- allMedia?: boolean;
241
+ allMedia?: boolean | undefined;
240
242
  /** Pass in an array of sites you don't want `og`s to run on. */
241
- blacklist?: string[];
243
+ blacklist?: string[] | undefined;
242
244
  /** Set the accept-encoding to `gzip/deflate` (default: `true`). */
243
- decompress?: boolean;
245
+ decompress?: boolean | undefined;
244
246
  /**
245
247
  * Setting this to `null` might help with running `og`s on non english websites (default: `utf8`).
246
248
  * @deprecated
247
249
  */
248
- encoding?: string | null;
250
+ encoding?: string | null | undefined;
249
251
  /** Defines if redirect responses should be followed automatically (default: `true`). */
250
- followRedirect?: boolean;
252
+ followRedirect?: boolean | undefined;
251
253
  /** An object containing request headers. Useful for setting the user-agent. */
252
- headers?: Record<string, string>;
254
+ headers?: Record<string, string> | undefined;
253
255
  /** You can pass in an HTML string to run `og`s on it (use without `options.url`). */
254
- html?: string;
256
+ html?: string | undefined;
255
257
  /** Max number of redirects `og`s will follow (default: `10`). */
256
- maxRedirects?: number;
258
+ maxRedirects?: number | undefined;
257
259
  /** Fetch other images if no open graph ones are found (default: `true`). */
258
- ogImageFallback?: boolean;
260
+ ogImageFallback?: boolean | undefined;
259
261
  /** Only fetch open graph info and don't fall back on anything else (default: `false`). */
260
- onlyGetOpenGraphInfo?: boolean;
262
+ onlyGetOpenGraphInfo?: boolean | undefined;
261
263
  /** Sets the peekSize for the request (default: `1024`). */
262
- peekSize?: number;
264
+ peekSize?: number | undefined;
263
265
  /** Number of times `og`s will retry the request (default: `2`). */
264
- retry?: number;
266
+ retry?: number | undefined;
265
267
  /** Timeout of the request in ms (default: `2000`). */
266
- timeout?: number;
268
+ timeout?: number | undefined;
267
269
  /** URL of the site. */
268
270
  url: string;
269
271
  /** Sets the options used by `validator.js` for testing the URL. */
270
- urlValidatorSettings?: URLValidatorSettings;
272
+ urlValidatorSettings?: URLValidatorSettings | undefined;
271
273
  /** Here you can define custom meta tags you want to scrape. */
272
- customMetaTags?: CustomMetaTag[];
274
+ customMetaTags?: CustomMetaTag[] | undefined;
273
275
  }
274
276
  }
275
277
 
@@ -1,7 +1,8 @@
1
1
  {
2
2
  "name": "@types/open-graph-scraper",
3
- "version": "4.8.0",
3
+ "version": "4.8.2",
4
4
  "description": "TypeScript definitions for open-graph-scraper",
5
+ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/open-graph-scraper",
5
6
  "license": "MIT",
6
7
  "contributors": [
7
8
  {
@@ -21,6 +22,6 @@
21
22
  "dependencies": {
22
23
  "@types/node": "*"
23
24
  },
24
- "typesPublisherContentHash": "7b5a8b86155920d46150d99140cb9916e4be165620b3970bd930b237472f066d",
25
- "typeScriptVersion": "3.5"
25
+ "typesPublisherContentHash": "765a7edb94fd229ab033a9d761fe3786b2728dee8e272930e272c685e45f24f9",
26
+ "typeScriptVersion": "4.1"
26
27
  }