docs(js): align SDK docs with scrapegraph-js 2.1.0 type rename#53
Merged
VinciGit00 merged 1 commit intomainfrom Apr 22, 2026
Merged
docs(js): align SDK docs with scrapegraph-js 2.1.0 type rename#53VinciGit00 merged 1 commit intomainfrom
VinciGit00 merged 1 commit intomainfrom
Conversation
Upstream PR ScrapeGraphAI/scrapegraph-js#17 drops the `Api` prefix from all exported TypeScript types and Zod schemas (only `ApiResult<T>` keeps it) and renames monitor `*Input`/`*Params` to `*Request`. Runtime surface is unchanged. - sdks/javascript.mdx: note the 2.1.0 type/schema rename, bump version requirement, rename `FormatEntry[]` -> `FormatConfig[]` in the scrape and crawl parameter tables. - services/{scrape,extract,search,crawl,monitor}.mdx + transition-from-v1-to-v2.mdx: bump `scrapegraph-js` version pin from >= 2.0.1 to >= 2.1.0. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Member
Author
Endpoint validation β
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
scrapegraph-js#17(v2.1.0). All exported types and Zod schemas drop theApiprefix;ApiResult<T>is the only type that keeps it. Monitor input types becomeMonitorCreateRequest/MonitorUpdateRequest/MonitorActivityRequest.sdks/javascript.mdx: adds a 2.1.0 breaking-change callout, renamesFormatEntry[]βFormatConfig[]in the scrape and crawl parameter tables, and bumps the version pin.scrapegraph-jsversion pins>= 2.0.1β>= 2.1.0acrossservices/{scrape,extract,search,crawl,monitor}.mdxandtransition-from-v1-to-v2.mdx.Validation
Endpoint
extracttested against 5 live websites withscrapegraph-js@^2.1.0β 5/5 returnedstatus=success. Per-URL results will be posted as a PR comment. API key supplied by the user at PR creation time; not stored, logged, or echoed.Test plan
FormatConfigis the type name users see when they Ctrl+click into the SDKservices/*.mdxpages show the new version pintransition-from-v1-to-v2guide mentions 2.1.0 as the upgrade targetπ€ Generated with Claude Code