`Collection.currentStateAsChanges` JSDoc examples don’t match `CurrentStateAsChangesOptions`
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 88/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- typescript
- Domain
- documentation
Research direction
Read the JSDoc for Collection.currentStateAsChanges in packages/db/src/collection/index.ts and compare its examples with CurrentStateAsChangesOptions in packages/db/src/types.ts. Update the examples to match the accepted options and types; done when both examples type-check against the documented options.
Written by the indexing model from the issue text.
Description
- I've validated the bug against the latest version of DB packages
Describe the bug
The JSDoc on Collection.currentStateAsChanges documents options that the method's type doesn't accept:
whereExpression: eq(row.status, 'active'): CurrentStateAsChangesOptions has nowhereExpressionfield.where: (row) => row.status === 'active':whereis typedBasicExpression<boolean>, not a callback, so this example doesn't type-check either.
To Reproduce
- Create a collection
- Try JSDoc examples from
currentStateAsChanges
- Dominant language
- TypeScript
- Stars
- 4k
- Forks
- 277
- Avg merge
- 21h 21m
- Merged PRs (30d)
- 218
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
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.
More from TanStack/db
-
OfflineExecutor.dispose() never settles pendingTransactionPromisesPossibly taken @Claire-ovo claimed this 2 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
TanStack/db#2254 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
Difficulty 4/5 1-2 days Newbie friendliness 58/100
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
Maintainers usually reply within 1 day
Similar issues
-
Add: MahdawiounTV HDOpencheck:passed streams:add
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
iptv-org/iptv#56890 · 1 comment ·
Maintainers usually reply within 1 day
-
type: enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
franciscoBSalgueiro/en-croissant#1061 ·
Maintainers usually reply within 3 days
-
S: triage
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Maintainers usually reply within 1 day
-
comp/desktop desktop/shell os/windows P3 tool/file type/bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
NousResearch/hermes-agent#145928 ·
Maintainers usually reply within 1 day