chore: update tsdocs on list* calls to reflect limitless nature#14920
chore: update tsdocs on list* calls to reflect limitless nature#14920brettdebt wants to merge 1 commit intomedusajs:developfrom
Conversation
|
|
@brettdebt is attempting to deploy a commit to the medusajs Team on Vercel. A member of the Team first needs to authorize it. |
|
Thank you for your contribution! Could you please fill in the PR description following our pull request template? We need the What, Why, How, and Testing sections completed so we can review your PR efficiently. Once you've updated the description, another review will be triggered automatically. Thanks! |
Summary
What — What changes are introduced in this PR?
Update tsdoc to reflect lack of limit in
list*calls.Why — Why are these changes relevant or necessary?
The existing tsdoc is incorrect as
list*calls currently don't default to a limit of15.Note
Low Risk
Documentation-only updates across many module service interfaces; no runtime logic changes, so risk is low aside from potential confusion if the docs still diverge from actual behavior.
Overview
Updates TypeScript service interface TSDoc across core modules to state that
list*andlistAndCount*methods default to returning all records (not the first 15), and that pagination must be applied explicitly viaconfig.skip/config.take.Written by Cursor Bugbot for commit b38164d. This will update automatically on new commits. Configure here.