Skip to content

chore: update tsdocs on list* calls to reflect limitless nature#14920

Open
brettdebt wants to merge 1 commit intomedusajs:developfrom
brettdebt:chore/fix-list-limit-tsdocs
Open

chore: update tsdocs on list* calls to reflect limitless nature#14920
brettdebt wants to merge 1 commit intomedusajs:developfrom
brettdebt:chore/fix-list-limit-tsdocs

Conversation

@brettdebt
Copy link
Copy Markdown

@brettdebt brettdebt commented Mar 20, 2026

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 of 15.


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* and listAndCount* methods default to returning all records (not the first 15), and that pagination must be applied explicitly via config.skip/config.take.

Written by Cursor Bugbot for commit b38164d. This will update automatically on new commits. Configure here.

@brettdebt brettdebt requested a review from a team as a code owner March 20, 2026 18:13
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Mar 20, 2026

⚠️ No Changeset found

Latest commit: b38164d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 20, 2026

@brettdebt is attempting to deploy a commit to the medusajs Team on Vercel.

A member of the Team first needs to authorize it.

@medusa-os-bot
Copy link
Copy Markdown

medusa-os-bot bot commented Apr 9, 2026

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants