Repository navigation
docs: Add miscellaneous examples #4247
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
Merged
+78
−0
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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 hidden or 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 |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| --- | ||
| id: stop-crawler | ||
| title: Stopping the crawler early | ||
| --- | ||
|
|
||
| import RunnableCodeBlock from '@site/src/components/RunnableCodeBlock'; | ||
| import ApiLink from '@site/src/components/ApiLink'; | ||
| import StopCrawlerSource from '!!raw-loader!roa-loader!./stop-crawler.ts'; | ||
|
|
||
| Calling <ApiLink to="basic-crawler/class/BasicCrawler#stop">`crawler.stop()`</ApiLink> ends the run gracefully: no further requests are dispatched, the ones already being processed finish, and `crawler.run()` resolves. Requests still waiting in the queue are left there untouched, so a later `run()` picks up where this one left off. This is the way to stop once a result limit is reached, without draining the queue or marking the remaining requests as handled. | ||
|
|
||
| To abort immediately without waiting for in-flight requests, use <ApiLink to="basic-crawler/class/BasicCrawler#teardown">`crawler.teardown()`</ApiLink> instead. | ||
|
|
||
| <RunnableCodeBlock className="language-js" type="cheerio"> | ||
| {StopCrawlerSource} | ||
| </RunnableCodeBlock> |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| import { CheerioCrawler } from 'crawlee'; | ||
|
|
||
| const crawler = new CheerioCrawler({ | ||
| async requestHandler({ request, $, enqueueLinks, pushData, useState }) { | ||
| const state = await useState({ found: 0, limit: 10 }); | ||
|
|
||
| const price = $('.price').first().text(); | ||
| if (price) { | ||
| await pushData({ url: request.url, price }); | ||
| state.found++; | ||
| } | ||
|
|
||
| // Once we have what we came for, stop dispatching new requests. Requests already in | ||
| // flight finish normally and `crawler.run()` resolves; whatever is still queued stays queued. | ||
| if (state.found >= state.limit) { | ||
| crawler.stop('Collected enough prices'); | ||
| return; | ||
| } | ||
|
|
||
| await enqueueLinks(); | ||
| }, | ||
| }); | ||
|
|
||
| await crawler.run(['https://warehouse-theme-metal.myshopify.com/collections']); | ||
|
|
||
| // Calling `run()` again with no arguments continues with the requests left in the queue. | ||
| // Here we raise the limit first, otherwise the first request would stop the crawler again. | ||
| const state = await crawler.useState({ found: 0, limit: 10 }); | ||
| state.limit = 20; | ||
| await crawler.run(); | ||
This file contains hidden or 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 hidden or 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.
nit: let's maybe show how to resume the crawler as well? (what do I pass in
run()the second time?)