diff --git a/www/apps/resources/references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider/page.mdx b/www/apps/resources/references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider/page.mdx index b89d4a7e50..69b32cf2a5 100644 --- a/www/apps/resources/references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider/page.mdx +++ b/www/apps/resources/references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider/page.mdx @@ -132,10 +132,6 @@ class MyAuthProviderService extends AbstractAuthModuleProvider { `","description":"The provider's options.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validateOptions"/> -#### Returns - - - ### authenticate This method authenticates the user. diff --git a/www/apps/resources/references/file/classes/file.AbstractFileProviderService/page.mdx b/www/apps/resources/references/file/classes/file.AbstractFileProviderService/page.mdx index 228d0f2dfd..9485814364 100644 --- a/www/apps/resources/references/file/classes/file.AbstractFileProviderService/page.mdx +++ b/www/apps/resources/references/file/classes/file.AbstractFileProviderService/page.mdx @@ -116,10 +116,6 @@ class MyFileProviderService extends AbstractFileProviderService { `","description":"The provider's options.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validateOptions"/> -#### Returns - - - ### upload This method uploads a file using your provider's custom logic. diff --git a/www/apps/resources/references/notification/classes/notification.AbstractNotificationProviderService/page.mdx b/www/apps/resources/references/notification/classes/notification.AbstractNotificationProviderService/page.mdx index fd0116ef15..6fb3010a59 100644 --- a/www/apps/resources/references/notification/classes/notification.AbstractNotificationProviderService/page.mdx +++ b/www/apps/resources/references/notification/classes/notification.AbstractNotificationProviderService/page.mdx @@ -104,10 +104,6 @@ class MyNotificationProviderService extends AbstractNotificationProviderService `","description":"The provider's options.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validateOptions"/> -#### Returns - - - ### send This method is used to send a notification using the third-party provider or your custom logic. diff --git a/www/apps/resources/references/payment_provider/classes/payment_provider.AbstractPaymentProvider/page.mdx b/www/apps/resources/references/payment_provider/classes/payment_provider.AbstractPaymentProvider/page.mdx index c871d4649b..e2bb97ed62 100644 --- a/www/apps/resources/references/payment_provider/classes/payment_provider.AbstractPaymentProvider/page.mdx +++ b/www/apps/resources/references/payment_provider/classes/payment_provider.AbstractPaymentProvider/page.mdx @@ -135,10 +135,6 @@ class MyPaymentProviderService extends AbstractPaymentProvider { `","description":"The provider's options.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validateOptions"/> -#### Returns - - - ### capturePayment This method is used to capture a payment. The payment is captured in one of the following scenarios: diff --git a/www/apps/resources/references/workflows/StepResponse/methods/workflows.StepResponse.permanentFailure/page.mdx b/www/apps/resources/references/workflows/StepResponse/methods/workflows.StepResponse.permanentFailure/page.mdx index 04cf313fd3..f8f9e0bf7a 100644 --- a/www/apps/resources/references/workflows/StepResponse/methods/workflows.StepResponse.permanentFailure/page.mdx +++ b/www/apps/resources/references/workflows/StepResponse/methods/workflows.StepResponse.permanentFailure/page.mdx @@ -79,7 +79,3 @@ myWorkflow() ## Parameters - -## Returns - - diff --git a/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/returns.ts b/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/returns.ts index 3b5d20e39f..974585e2b5 100644 --- a/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/returns.ts +++ b/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/returns.ts @@ -10,13 +10,22 @@ export default function (theme: MarkdownTheme) { Handlebars.registerHelper( "returns", function (reflection: SignatureReflection) { + let returnContent = "" if (reflection.variant === "signature" && "type" in reflection) { - return getReturnFromType(theme, reflection) + returnContent = getReturnFromType(theme, reflection) } else if (reflection.comment) { - return getReturnFromComment(theme, reflection.comment, reflection.name) - } else { + returnContent = getReturnFromComment( + theme, + reflection.comment, + reflection.name + ) + } + + if (!returnContent.length) { return "" } + + return `${Handlebars.helpers.titleLevel()} Returns\n\n${returnContent}` } ) } @@ -44,6 +53,10 @@ function getReturnFromType( maxLevel, }) + if (!componentItems.length) { + return "" + } + if (parameterStyle === "component") { return formatParameterComponent({ parameterComponent, diff --git a/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.signature.hbs b/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.signature.hbs index 75a53b9513..cd48802916 100644 --- a/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.signature.hbs +++ b/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.signature.hbs @@ -68,12 +68,12 @@ {{#if type}} -{{{titleLevel}}} Returns - {{#if (sectionEnabled "member_signature_returns")}} {{#with type}} +{{{titleLevel}}} Returns + {{{type 'all'}}} {{/with}} diff --git a/www/utils/packages/typedoc-plugin-markdown-medusa/src/utils/reflection-type-parameters.ts b/www/utils/packages/typedoc-plugin-markdown-medusa/src/utils/reflection-type-parameters.ts index 75f0a0a5eb..c3b3416abb 100644 --- a/www/utils/packages/typedoc-plugin-markdown-medusa/src/utils/reflection-type-parameters.ts +++ b/www/utils/packages/typedoc-plugin-markdown-medusa/src/utils/reflection-type-parameters.ts @@ -280,12 +280,27 @@ export function loadComment( return "" } +const emptyValues = ["void", "never", "undefined"] + export function isEmpty(reflectionTypes: SomeType[]) { - return reflectionTypes.every( - (type) => - type.type === "intrinsic" && - (type.name === "void" || - type.name === "never" || - type.name === "undefined") - ) + return reflectionTypes.every((type) => { + if (type.type === "intrinsic" && emptyValues.includes(type.name)) { + return true + } + + if (type.type !== "union") { + return false + } + + return type.types.every((unionType) => { + if ( + unionType.type === "intrinsic" && + emptyValues.includes(unionType.name) + ) { + return true + } + + return false + }) + }) }