Adding Types to Medusa Configuration Export #3275
Replies: 3 comments 5 replies
-
Think this is excellent - we should definitely do this. Is it something you'd be interested in working on? |
Beta Was this translation helpful? Give feedback.
-
Yay! 🎉 |
Beta Was this translation helpful? Give feedback.
-
@adevinwild, thanks for contributing! If you are up for it, I think it would also be great to add JSDoc descriptions to the properties here so they are available as you type. Do you want to jump on this too? |
Beta Was this translation helpful? Give feedback.
-
Hi 👋
Users can customize the platform by exporting a configuration object and it's really great!
However, there is currently no explicit documentation for the configuration object's properties, making it difficult to determine which features are accessible for customization.
I propose adding types by default to the Medusa configuration object in order to give better description for the accessible properties.
Proposal
The addition of JSDoc types to the module is our suggestion.
Objects are exported in the medusa-config.js file. The format suggested is:
/** @type {import('@medusajs/medusa').ConfigModule} */
What do you think about it?
Beta Was this translation helpful? Give feedback.
All reactions