larksuite / larksuite/node-sdk
README pagination example uses an undefined SDKClient identifier
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 294
- Forks
- 54
- Avg merge
- 3d 13h
- Merged PRs (30d)
- 4
Description
Summary
The pagination example in both the English and Chinese README uses an undefined SDKClient identifier after creating the client as client.
Affected version
@larksuiteoapi/node-sdk1.73.0mainatf54b49f3566c52b54c598194b7ed3015e3e24224
Location
README.md, pagination example near line 152README.zh.md, pagination example near line 174
Both currently contain:
const listIterator = await SDKClient.contact.user.listWithIterator({
The surrounding quick-start code declares const client = new lark.Client(...); it never defines SDKClient.
Expected behavior
The example should call client.contact.user.listWithIterator(...), matching the instantiated client used by the surrounding documentation.
Actual behavior
Copying the example produces ReferenceError: SDKClient is not defined (or a TypeScript unresolved-name error).
Impact
The first documented pagination example cannot run as written, and the same error is duplicated across both maintained locales.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open README.md near line 152 and README.zh.md near line 174, then compare the pagination snippets with the surrounding quick-start code. Update both examples so they use the instantiated client, and verify that neither contains the undefined SDKClient identifier.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 92/100