asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: migrate guides to TSDoc references (#6100)

Browse Source
This commit is contained in:
Shahed Nasser
2024-01-22 19:38:35 +02:00
committed by GitHub
parent 85dad169bb
commit 4792c55226
980 changed files with 195537 additions and 160619 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/modules/file.mdx
+11
View File
@@ -0,0 +1,11 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
# file
## Classes
- [AbstractFileService](../file/classes/file.AbstractFileService.mdx)
## Interfaces
- [IFileService](../file/interfaces/file.IFileService.mdx)
www/apps/docs/content/references/modules/medusa.mdx
+1321 -1629
View File
File diff suppressed because one or more lines are too long
www/apps/docs/content/references/modules/medusa_config.mdx
+9
View File
@@ -0,0 +1,9 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
# medusa-config
## Interfaces
- [HttpCompressionOptions](../medusa_config/interfaces/medusa_config.HttpCompressionOptions.mdx)
- [ProjectConfigOptions](../medusa_config/interfaces/medusa_config.ProjectConfigOptions.mdx)
- [ConfigModule](../medusa_config/interfaces/medusa_config.ConfigModule.mdx)
www/apps/docs/content/references/modules/notification.mdx
+12
View File
@@ -0,0 +1,12 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
# notification
## Classes
- [AbstractNotificationService](../notification/classes/notification.AbstractNotificationService.mdx)
## Interfaces
- [ReturnedData](../notification/interfaces/notification.ReturnedData.mdx)
- [INotificationService](../notification/interfaces/notification.INotificationService.mdx)
www/apps/docs/content/references/modules/price_selection.mdx
+29
View File
@@ -0,0 +1,29 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
# price-selection
## Classes
- [AbstractPriceSelectionStrategy](../price_selection/classes/price_selection.AbstractPriceSelectionStrategy.mdx)
## Interfaces
- [IPriceSelectionStrategy](../price_selection/interfaces/price_selection.IPriceSelectionStrategy.mdx)
- [PriceSelectionContext](../price_selection/interfaces/price_selection.PriceSelectionContext.mdx)
- [PriceSelectionResult](../price_selection/interfaces/price_selection.PriceSelectionResult.mdx)
## Type Aliases
- [PriceType](../price_selection/types/price_selection.PriceType.mdx)
___
## Variables
### PriceType
**PriceType**: `Object`
#### Properties
<ParameterTypes parameters={[{"name":"DEFAULT","type":"[DEFAULT](medusa.mdx#default)","description":"","optional":false,"defaultValue":"\"default\"","expandable":false,"children":[]},{"name":"OVERRIDE","type":"[OVERRIDE](../medusa/enums/medusa.PriceListType.mdx#override)","description":"","optional":false,"defaultValue":"\"override\"","expandable":false,"children":[]},{"name":"SALE","type":"[SALE](../medusa/enums/medusa.PriceListType.mdx#sale)","description":"","optional":false,"defaultValue":"\"sale\"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/modules/search.mdx
+7
View File
@@ -0,0 +1,7 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
# search
## Classes
- [AbstractSearchService](../search/classes/search.AbstractSearchService.mdx)
www/apps/docs/content/references/modules/tax.mdx
+17
View File
@@ -0,0 +1,17 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
# tax
## Classes
- [AbstractTaxService](../tax/classes/tax.AbstractTaxService.mdx)
## Interfaces
- [ITaxService](../tax/interfaces/tax.ITaxService.mdx)
## Type Aliases
- [ItemTaxCalculationLine](../tax/types/tax.ItemTaxCalculationLine.mdx)
- [ShippingTaxCalculationLine](../tax/types/tax.ShippingTaxCalculationLine.mdx)
- [TaxCalculationContext](../tax/types/tax.TaxCalculationContext.mdx)
www/apps/docs/content/references/modules/tax_calculation.mdx
+11
View File
@@ -0,0 +1,11 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
# tax-calculation
## Classes
- [AbstractTaxCalculationStrategy](../tax_calculation/classes/tax_calculation.AbstractTaxCalculationStrategy.mdx)
## Interfaces
- [ITaxCalculationStrategy](../tax_calculation/interfaces/tax_calculation.ITaxCalculationStrategy.mdx)
www/apps/docs/content/references/modules/types.mdx
+77 -76
View File
@@ -23,9 +23,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Enumerations
- [ProviderDomain](../types/enums/types.ProviderDomain.mdx)
- [PriceListStatus](../types/enums/types.PriceListStatus.mdx)
- [PriceListType](../types/enums/types.PriceListType.mdx)
- [ProviderDomain](../types/enums/types.ProviderDomain.mdx)
## Classes
@@ -33,107 +33,108 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Interfaces
- [AddPriceListPricesDTO](../types/interfaces/types.AddPriceListPricesDTO.mdx)
- [AddPricesDTO](../types/interfaces/types.AddPricesDTO.mdx)
- [AddRulesDTO](../types/interfaces/types.AddRulesDTO.mdx)
- [BaseRepositoryService](../types/interfaces/types.BaseRepositoryService.mdx)
- [CalculatedPriceSet](../types/interfaces/types.CalculatedPriceSet.mdx)
- [CalculatedPriceSetDTO](../types/interfaces/types.CalculatedPriceSetDTO.mdx)
- [Context](../types/interfaces/types.Context.mdx)
- [CreateCurrencyDTO](../types/interfaces/types.CreateCurrencyDTO.mdx)
- [CreateMoneyAmountDTO](../types/interfaces/types.CreateMoneyAmountDTO.mdx)
- [CreatePriceListDTO](../types/interfaces/types.CreatePriceListDTO.mdx)
- [CreatePriceListRuleDTO](../types/interfaces/types.CreatePriceListRuleDTO.mdx)
- [CreatePriceListRuleValueDTO](../types/interfaces/types.CreatePriceListRuleValueDTO.mdx)
- [CreatePriceListRules](../types/interfaces/types.CreatePriceListRules.mdx)
- [CreatePriceRuleDTO](../types/interfaces/types.CreatePriceRuleDTO.mdx)
- [CreatePriceSetDTO](../types/interfaces/types.CreatePriceSetDTO.mdx)
- [CreatePriceSetMoneyAmountDTO](../types/interfaces/types.CreatePriceSetMoneyAmountDTO.mdx)
- [CreatePriceSetMoneyAmountRulesDTO](../types/interfaces/types.CreatePriceSetMoneyAmountRulesDTO.mdx)
- [CreatePriceSetPriceRules](../types/interfaces/types.CreatePriceSetPriceRules.mdx)
- [CreatePriceSetRuleTypeDTO](../types/interfaces/types.CreatePriceSetRuleTypeDTO.mdx)
- [CreatePricesDTO](../types/interfaces/types.CreatePricesDTO.mdx)
- [CreateRuleTypeDTO](../types/interfaces/types.CreateRuleTypeDTO.mdx)
- [CurrencyDTO](../types/interfaces/types.CurrencyDTO.mdx)
- [FilterableAuthProviderProps](../types/interfaces/types.FilterableAuthProviderProps.mdx)
- [FilterableAuthUserProps](../types/interfaces/types.FilterableAuthUserProps.mdx)
- [IAuthenticationModuleService](../types/interfaces/types.IAuthenticationModuleService.mdx)
- [SessionOptions](../types/interfaces/types.SessionOptions.mdx)
- [BaseRepositoryService](../types/interfaces/types.BaseRepositoryService.mdx)
- [FileServiceUploadResult](../types/interfaces/types.FileServiceUploadResult.mdx)
- [FileServiceGetUploadStreamResult](../types/interfaces/types.FileServiceGetUploadStreamResult.mdx)
- [GetUploadedFileType](../types/interfaces/types.GetUploadedFileType.mdx)
- [DeleteFileType](../types/interfaces/types.DeleteFileType.mdx)
- [UploadStreamDescriptorType](../types/interfaces/types.UploadStreamDescriptorType.mdx)
- [JoinerServiceConfigAlias](../types/interfaces/types.JoinerServiceConfigAlias.mdx)
- [JoinerServiceConfig](../types/interfaces/types.JoinerServiceConfig.mdx)
- [JoinerArgument](../types/interfaces/types.JoinerArgument.mdx)
- [JoinerDirective](../types/interfaces/types.JoinerDirective.mdx)
- [RemoteJoinerQuery](../types/interfaces/types.RemoteJoinerQuery.mdx)
- [RemoteNestedExpands](../types/interfaces/types.RemoteNestedExpands.mdx)
- [RemoteExpandProperty](../types/interfaces/types.RemoteExpandProperty.mdx)
- [ILinkModule](../types/interfaces/types.ILinkModule.mdx)
- [IPaymentModuleService](../types/interfaces/types.IPaymentModuleService.mdx)
- [CurrencyDTO](../types/interfaces/types.CurrencyDTO.mdx)
- [CreateCurrencyDTO](../types/interfaces/types.CreateCurrencyDTO.mdx)
- [UpdateCurrencyDTO](../types/interfaces/types.UpdateCurrencyDTO.mdx)
- [FilterableCurrencyProps](../types/interfaces/types.FilterableCurrencyProps.mdx)
- [MoneyAmountDTO](../types/interfaces/types.MoneyAmountDTO.mdx)
- [CreateMoneyAmountDTO](../types/interfaces/types.CreateMoneyAmountDTO.mdx)
- [UpdateMoneyAmountDTO](../types/interfaces/types.UpdateMoneyAmountDTO.mdx)
- [FilterableMoneyAmountProps](../types/interfaces/types.FilterableMoneyAmountProps.mdx)
- [PriceListDTO](../types/interfaces/types.PriceListDTO.mdx)
- [PriceListPriceDTO](../types/interfaces/types.PriceListPriceDTO.mdx)
- [CreatePriceSetPriceRules](../types/interfaces/types.CreatePriceSetPriceRules.mdx)
- [CreatePriceListRules](../types/interfaces/types.CreatePriceListRules.mdx)
- [CreatePriceListDTO](../types/interfaces/types.CreatePriceListDTO.mdx)
- [UpdatePriceListDTO](../types/interfaces/types.UpdatePriceListDTO.mdx)
- [FilterablePriceListProps](../types/interfaces/types.FilterablePriceListProps.mdx)
- [FilterablePriceListRuleProps](../types/interfaces/types.FilterablePriceListRuleProps.mdx)
- [FilterablePriceListRuleValueProps](../types/interfaces/types.FilterablePriceListRuleValueProps.mdx)
- [FilterablePriceRuleProps](../types/interfaces/types.FilterablePriceRuleProps.mdx)
- [FilterablePriceSetMoneyAmountProps](../types/interfaces/types.FilterablePriceSetMoneyAmountProps.mdx)
- [FilterablePriceSetMoneyAmountRulesProps](../types/interfaces/types.FilterablePriceSetMoneyAmountRulesProps.mdx)
- [FilterablePriceSetProps](../types/interfaces/types.FilterablePriceSetProps.mdx)
- [FilterablePriceSetRuleTypeProps](../types/interfaces/types.FilterablePriceSetRuleTypeProps.mdx)
- [FilterableRuleTypeProps](../types/interfaces/types.FilterableRuleTypeProps.mdx)
- [IAuthenticationModuleService](../types/interfaces/types.IAuthenticationModuleService.mdx)
- [ILinkModule](../types/interfaces/types.ILinkModule.mdx)
- [InputPrice](../types/interfaces/types.InputPrice.mdx)
- [JoinerArgument](../types/interfaces/types.JoinerArgument.mdx)
- [JoinerDirective](../types/interfaces/types.JoinerDirective.mdx)
- [JoinerServiceConfig](../types/interfaces/types.JoinerServiceConfig.mdx)
- [JoinerServiceConfigAlias](../types/interfaces/types.JoinerServiceConfigAlias.mdx)
- [MoneyAmountDTO](../types/interfaces/types.MoneyAmountDTO.mdx)
- [PriceListDTO](../types/interfaces/types.PriceListDTO.mdx)
- [PriceListPriceDTO](../types/interfaces/types.PriceListPriceDTO.mdx)
- [PriceListRuleDTO](../types/interfaces/types.PriceListRuleDTO.mdx)
- [CreatePriceListRuleDTO](../types/interfaces/types.CreatePriceListRuleDTO.mdx)
- [UpdatePriceListRuleDTO](../types/interfaces/types.UpdatePriceListRuleDTO.mdx)
- [PriceListRuleValueDTO](../types/interfaces/types.PriceListRuleValueDTO.mdx)
- [CreatePriceListRuleValueDTO](../types/interfaces/types.CreatePriceListRuleValueDTO.mdx)
- [UpdatePriceListRuleValueDTO](../types/interfaces/types.UpdatePriceListRuleValueDTO.mdx)
- [AddPriceListPricesDTO](../types/interfaces/types.AddPriceListPricesDTO.mdx)
- [SetPriceListRulesDTO](../types/interfaces/types.SetPriceListRulesDTO.mdx)
- [RemovePriceListRulesDTO](../types/interfaces/types.RemovePriceListRulesDTO.mdx)
- [PriceRuleDTO](../types/interfaces/types.PriceRuleDTO.mdx)
- [PriceSetDTO](../types/interfaces/types.PriceSetDTO.mdx)
- [PriceSetMoneyAmountDTO](../types/interfaces/types.PriceSetMoneyAmountDTO.mdx)
- [CreatePriceRuleDTO](../types/interfaces/types.CreatePriceRuleDTO.mdx)
- [UpdatePriceRuleDTO](../types/interfaces/types.UpdatePriceRuleDTO.mdx)
- [FilterablePriceRuleProps](../types/interfaces/types.FilterablePriceRuleProps.mdx)
- [PriceSetMoneyAmountRulesDTO](../types/interfaces/types.PriceSetMoneyAmountRulesDTO.mdx)
- [CreatePriceSetMoneyAmountRulesDTO](../types/interfaces/types.CreatePriceSetMoneyAmountRulesDTO.mdx)
- [UpdatePriceSetMoneyAmountRulesDTO](../types/interfaces/types.UpdatePriceSetMoneyAmountRulesDTO.mdx)
- [FilterablePriceSetMoneyAmountRulesProps](../types/interfaces/types.FilterablePriceSetMoneyAmountRulesProps.mdx)
- [PriceSetMoneyAmountDTO](../types/interfaces/types.PriceSetMoneyAmountDTO.mdx)
- [UpdatePriceSetMoneyAmountDTO](../types/interfaces/types.UpdatePriceSetMoneyAmountDTO.mdx)
- [CreatePriceSetMoneyAmountDTO](../types/interfaces/types.CreatePriceSetMoneyAmountDTO.mdx)
- [FilterablePriceSetMoneyAmountProps](../types/interfaces/types.FilterablePriceSetMoneyAmountProps.mdx)
- [PriceSetRuleTypeDTO](../types/interfaces/types.PriceSetRuleTypeDTO.mdx)
- [CreatePriceSetRuleTypeDTO](../types/interfaces/types.CreatePriceSetRuleTypeDTO.mdx)
- [UpdatePriceSetRuleTypeDTO](../types/interfaces/types.UpdatePriceSetRuleTypeDTO.mdx)
- [FilterablePriceSetRuleTypeProps](../types/interfaces/types.FilterablePriceSetRuleTypeProps.mdx)
- [PricingRepositoryService](../types/interfaces/types.PricingRepositoryService.mdx)
- [PricingContext](../types/interfaces/types.PricingContext.mdx)
- [PricingFilters](../types/interfaces/types.PricingFilters.mdx)
- [PricingRepositoryService](../types/interfaces/types.PricingRepositoryService.mdx)
- [ProductCategoryTransformOptions](../types/interfaces/types.ProductCategoryTransformOptions.mdx)
- [RemoteExpandProperty](../types/interfaces/types.RemoteExpandProperty.mdx)
- [RemoteJoinerQuery](../types/interfaces/types.RemoteJoinerQuery.mdx)
- [RemoteNestedExpands](../types/interfaces/types.RemoteNestedExpands.mdx)
- [RemovePriceListRulesDTO](../types/interfaces/types.RemovePriceListRulesDTO.mdx)
- [PriceSetDTO](../types/interfaces/types.PriceSetDTO.mdx)
- [CalculatedPriceSetDTO](../types/interfaces/types.CalculatedPriceSetDTO.mdx)
- [CalculatedPriceSet](../types/interfaces/types.CalculatedPriceSet.mdx)
- [AddRulesDTO](../types/interfaces/types.AddRulesDTO.mdx)
- [CreatePricesDTO](../types/interfaces/types.CreatePricesDTO.mdx)
- [AddPricesDTO](../types/interfaces/types.AddPricesDTO.mdx)
- [RemovePriceSetRulesDTO](../types/interfaces/types.RemovePriceSetRulesDTO.mdx)
- [RuleTypeDTO](../types/interfaces/types.RuleTypeDTO.mdx)
- [SetPriceListRulesDTO](../types/interfaces/types.SetPriceListRulesDTO.mdx)
- [SharedContext](../types/interfaces/types.SharedContext.mdx)
- [UpdateCurrencyDTO](../types/interfaces/types.UpdateCurrencyDTO.mdx)
- [UpdateMoneyAmountDTO](../types/interfaces/types.UpdateMoneyAmountDTO.mdx)
- [UpdatePriceListDTO](../types/interfaces/types.UpdatePriceListDTO.mdx)
- [UpdatePriceListRuleDTO](../types/interfaces/types.UpdatePriceListRuleDTO.mdx)
- [UpdatePriceListRuleValueDTO](../types/interfaces/types.UpdatePriceListRuleValueDTO.mdx)
- [UpdatePriceRuleDTO](../types/interfaces/types.UpdatePriceRuleDTO.mdx)
- [CreatePriceSetDTO](../types/interfaces/types.CreatePriceSetDTO.mdx)
- [UpdatePriceSetDTO](../types/interfaces/types.UpdatePriceSetDTO.mdx)
- [UpdatePriceSetMoneyAmountDTO](../types/interfaces/types.UpdatePriceSetMoneyAmountDTO.mdx)
- [UpdatePriceSetMoneyAmountRulesDTO](../types/interfaces/types.UpdatePriceSetMoneyAmountRulesDTO.mdx)
- [UpdatePriceSetRuleTypeDTO](../types/interfaces/types.UpdatePriceSetRuleTypeDTO.mdx)
- [FilterablePriceSetProps](../types/interfaces/types.FilterablePriceSetProps.mdx)
- [RuleTypeDTO](../types/interfaces/types.RuleTypeDTO.mdx)
- [CreateRuleTypeDTO](../types/interfaces/types.CreateRuleTypeDTO.mdx)
- [UpdateRuleTypeDTO](../types/interfaces/types.UpdateRuleTypeDTO.mdx)
- [FilterableRuleTypeProps](../types/interfaces/types.FilterableRuleTypeProps.mdx)
- [ProductCategoryTransformOptions](../types/interfaces/types.ProductCategoryTransformOptions.mdx)
- [SharedContext](../types/interfaces/types.SharedContext.mdx)
- [Context](../types/interfaces/types.Context.mdx)
- [InputPrice](../types/interfaces/types.InputPrice.mdx)
## Type Aliases
- [AddressDTO](../types/types/types.AddressDTO.mdx)
- [AuthProviderDTO](../types/types/types.AuthProviderDTO.mdx)
- [AuthUserDTO](../types/types/types.AuthUserDTO.mdx)
- [CreateAuthProviderDTO](../types/types/types.CreateAuthProviderDTO.mdx)
- [UpdateAuthProviderDTO](../types/types/types.UpdateAuthProviderDTO.mdx)
- [AuthUserDTO](../types/types/types.AuthUserDTO.mdx)
- [CreateAuthUserDTO](../types/types/types.CreateAuthUserDTO.mdx)
- [DeleteFileType](../types/types/types.DeleteFileType.mdx)
- [UpdateAuthUserDTO](../types/types/types.UpdateAuthUserDTO.mdx)
- [Dictionary](../types/types/types.Dictionary.mdx)
- [Query](../types/types/types.Query.mdx)
- [ExpandScalar](../types/types/types.ExpandScalar.mdx)
- [FileServiceGetUploadStreamResult](../types/types/types.FileServiceGetUploadStreamResult.mdx)
- [FileServiceUploadResult](../types/types/types.FileServiceUploadResult.mdx)
- [FilterValue](../types/types/types.FilterValue.mdx)
- [Scalar](../types/types/types.Scalar.mdx)
- [ReadonlyPrimary](../types/types/types.ReadonlyPrimary.mdx)
- [Primary](../types/types/types.Primary.mdx)
- [OperatorMap](../types/types/types.OperatorMap.mdx)
- [FilterValue2](../types/types/types.FilterValue2.mdx)
- [GetUploadedFileType](../types/types/types.GetUploadedFileType.mdx)
- [FilterValue](../types/types/types.FilterValue.mdx)
- [PrevLimit](../types/types/types.PrevLimit.mdx)
- [Order](../types/types/types.Order.mdx)
- [JoinerRelationship](../types/types/types.JoinerRelationship.mdx)
- [ModuleDeclaration](../types/types/types.ModuleDeclaration.mdx)
- [OperatorMap](../types/types/types.OperatorMap.mdx)
- [Order](../types/types/types.Order.mdx)
- [PrevLimit](../types/types/types.PrevLimit.mdx)
- [Primary](../types/types/types.Primary.mdx)
- [Query](../types/types/types.Query.mdx)
- [ReadonlyPrimary](../types/types/types.ReadonlyPrimary.mdx)
- [Scalar](../types/types/types.Scalar.mdx)
- [SessionOptions](../types/types/types.SessionOptions.mdx)
- [UpdateAuthProviderDTO](../types/types/types.UpdateAuthProviderDTO.mdx)
- [UpdateAuthUserDTO](../types/types/types.UpdateAuthUserDTO.mdx)
- [UploadStreamDescriptorType](../types/types/types.UploadStreamDescriptorType.mdx)