-
Notifications
You must be signed in to change notification settings - Fork 45
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: changelog for v4 #115
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
53bd480
chore: changelog for v4
vladfrangu d76c939
chore: dang quote
vladfrangu 6744c98
chore: lower node requirement and changelog
vladfrangu 1fecbc4
chore: le readme
vladfrangu 31c54c5
chore: I need to stop forgetting these things
vladfrangu File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,7 +9,9 @@ $ npm install got-scraping | |
``` | ||
|
||
**Note:** | ||
> - Node.js >=15.10.0 is required due to instability of HTTP/2 support in lower versions. | ||
> This project is ESM only, which means it can only be imported using the `import` statement or the `import()` method. It is not possible to `require()` it. | ||
|
||
> - Node.js >=16 is required due to instability of HTTP/2 support in lower versions. | ||
|
||
## API | ||
|
||
|
@@ -18,11 +20,22 @@ Got scraping package is built using the [`got.extend(...)`](https://github.com/s | |
Interested what's [under the hood](#under-the-hood)? | ||
|
||
```javascript | ||
const { gotScraping } = require('got-scraping'); | ||
import { gotScraping } from 'got-scraping'; | ||
|
||
gotScraping | ||
.get('https://apify.com') | ||
.then( ({ body }) => console.log(body)) | ||
.then( ({ body }) => console.log(body)); | ||
``` | ||
|
||
```javascript | ||
// If you're still using CJS and cannot use the import syntax | ||
let gotScraping; | ||
|
||
async function fetchWithGotScraping(url) { | ||
gotScraping ??= (await import('got-scraping')).gotScraping; | ||
|
||
return gotScraping.get(url); | ||
} | ||
``` | ||
|
||
### options | ||
|
@@ -34,14 +47,14 @@ Type: **`string`** | |
URL of the HTTP or HTTPS based proxy. HTTP/2 proxies are supported as well. | ||
|
||
```javascript | ||
const { gotScraping } = require('got-scraping'); | ||
import { gotScraping } from 'got-scraping'; | ||
|
||
gotScraping | ||
.get({ | ||
url: 'https://apify.com', | ||
proxyUrl: 'http://usernamed:[email protected]:1234', | ||
}) | ||
.then(({ body }) => console.log(body)) | ||
.then(({ body }) => console.log(body)); | ||
``` | ||
|
||
#### `useHeaderGenerator` | ||
|
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
there should be (somewhere) a note about this project being ESM only too