Skip to content

docs: improve node formatting #933

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.

Sign up for GitHub

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

Open
firecrawl-spring wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −6
Open

docs: improve node formatting #933

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions sdks/node.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,11 +121,11 @@ Use the waiter method `crawl` for the simplest experience, or start a job and pa

##### Simple crawl (auto-pagination, default)

- See the default flow in [Crawling a Website](#crawling-a-website).
See the default flow in [Crawling a Website](#crawling-a-website).

##### Manual crawl with pagination control (single page)

- Start a job, then fetch one page at a time with `autoPaginate: false`.
Start a job, then fetch one page at a time with `autoPaginate: false`:

```js Node
const crawlStart = await firecrawl.startCrawl('https://docs.firecrawl.dev', { limit: 5 });
Expand All @@ -137,7 +137,7 @@ console.log('crawl single page:', crawlSingle.status, 'docs:', crawlSingle.data.

##### Manual crawl with limits (auto-pagination + early stop)

- Keep auto-pagination on but stop early with `maxPages`, `maxResults`, or `maxWaitTime`.
Keep auto-pagination on but stop early with `maxPages`, `maxResults`, or `maxWaitTime`:

```js Node
const crawlLimited = await firecrawl.getCrawlStatus(crawlJobId, {
Expand All @@ -155,11 +155,11 @@ Use the waiter method `batchScrape`, or start a job and page manually.

##### Simple batch scrape (auto-pagination, default)

- See the default flow in [Batch Scrape](/features/batch-scrape).
See the default flow in [Batch Scrape](/features/batch-scrape).

##### Manual batch scrape with pagination control (single page)

- Start a job, then fetch one page at a time with `autoPaginate: false`.
Start a job, then fetch one page at a time with `autoPaginate: false`:

```js Node
const batchStart = await firecrawl.startBatchScrape([
Expand All @@ -174,7 +174,7 @@ console.log('batch single page:', batchSingle.status, 'docs:', batchSingle.data.

##### Manual batch scrape with limits (auto-pagination + early stop)

- Keep auto-pagination on but stop early with `maxPages`, `maxResults`, or `maxWaitTime`.
Keep auto-pagination on but stop early with `maxPages`, `maxResults`, or `maxWaitTime`:

```js Node
const batchLimited = await firecrawl.getBatchScrapeStatus(batchJobId, {
Expand Down