Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(types): Add TSDoc comments to IInventoryService #5630

Merged
merged 5 commits into from
Nov 15, 2023

Conversation

shahednasser
Copy link
Member

  • Add TSDoc comments to the IInventoryService so that we can generate a reference later for the inventory module.
  • Small fixes to the product module's TSDocs.

@shahednasser shahednasser requested a review from a team as a code owner November 14, 2023 12:02
Copy link

changeset-bot bot commented Nov 14, 2023

🦋 Changeset detected

Latest commit: 593f5fc

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages
Name Type
@medusajs/types Patch
@medusajs/medusa-oas-cli Patch
@medusajs/oas-github-ci Patch

Not sure what this means? Click here to learn what changesets are.

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

Copy link

vercel bot commented Nov 14, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

3 Ignored Deployments
Name Status Preview Comments Updated (UTC)
api-reference ⬜️ Ignored (Inspect) Visit Preview Nov 15, 2023 1:54pm
docs-ui ⬜️ Ignored (Inspect) Visit Preview Nov 15, 2023 1:54pm
medusa-docs ⬜️ Ignored (Inspect) Visit Preview Nov 15, 2023 1:54pm

Copy link
Contributor

@pKorsholm pKorsholm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, just a couple of nits

packages/types/src/inventory/service.ts Outdated Show resolved Hide resolved
packages/types/src/inventory/service.ts Outdated Show resolved Hide resolved
packages/types/src/inventory/service.ts Outdated Show resolved Hide resolved
packages/types/src/inventory/service.ts Outdated Show resolved Hide resolved
packages/types/src/inventory/service.ts Outdated Show resolved Hide resolved
packages/types/src/inventory/service.ts Outdated Show resolved Hide resolved
Comment on lines +371 to +372
* @prop inventory_item_id - The ID of the associated inventory level.
* @prop location_id - The ID of the associated location.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question: should we include stocked_quantity and incoming_quantity in this?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It includes the TSDoc comments for them defined in UpdateInventoryLevelInput by default.

packages/types/src/inventory/common.ts Outdated Show resolved Hide resolved
@shahednasser shahednasser merged commit 61aef4a into develop Nov 15, 2023
12 checks passed
@shahednasser shahednasser deleted the chore/inventory-tsdoc branch November 15, 2023 15:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants