Fix the ParcelDesk SDK quickstart - #1
Open
ZIJ wants to merge 1 commit into
Open
Conversation
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.
The scheduled quickstart check reproduced a failure in
docs/quickstart.mdagainst the released ParcelDesk SDK. ParcelDesk is a deliberately constructed example fixture.Diagnosis: released parceldesk-sdk-2.0.0.tgz's client.orders.list() resolves to a paged response object { items, nextCursor } (confirmed in the installed package's src/index.js and src/index.d.ts:
Promise<OrderPage>whereOrderPage = { items: Order[]; nextCursor: string | null }). The guide's snippet assigned the raw resolved value toordersand called.map()directly on it, which throws because the value is a plain object, not an array. Fix: destructureitemsfrom the resolved page (const { items: orders } = await client.orders.list({ limit: 2 });) so.map()operates on the actual array. No other guide content, SDK release URL, version, or expected output changed.Verification command, run before and after the documentation change in separate fresh projects:
Before:
After:
Only
docs/quickstart.mdis changed. The SDK release and expected result are preserved.