npm - @vendure/docs - Versions diffs - 0.0.0-202601210957 → 0.0.0-202601211038 - Mend

@vendure/docs 0.0.0-202601210957 → 0.0.0-202601211038

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (585) hide show

package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "DefaultProductVariantPriceCalculationStrategy"
 generated: true
 ---
-## DefaultProductVariantPriceCalculationStrategy
 <GenerationInfo sourceFile="packages/core/src/config/catalog/default-product-variant-price-calculation-strategy.ts" sourceLine="18" packageName="@vendure/core" />
 A default ProductVariant price calculation function.

package/docs/reference/typescript-api/products-stock/default-stock-display-strategy.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "DefaultStockDisplayStrategy"
 generated: true
 ---
-## DefaultStockDisplayStrategy
 <GenerationInfo sourceFile="packages/core/src/config/catalog/default-stock-display-strategy.ts" sourceLine="14" packageName="@vendure/core" />
 Displays the `ProductVariant.stockLevel` as either `'IN_STOCK'`, `'OUT_OF_STOCK'` or `'LOW_STOCK'`.

package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx CHANGED Viewed

@@ -2,14 +2,10 @@
 title: "DefaultStockLocationStrategy"
 generated: true
 ---
-## DefaultStockLocationStrategy
 <GenerationInfo sourceFile="packages/core/src/config/catalog/default-stock-location-strategy.ts" sourceLine="105" packageName="@vendure/core" since="2.0.0" />
-The DefaultStockLocationStrategy was the default implementation of the <a href='/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy'>StockLocationStrategy</a>
-prior to the introduction of the <a href='/reference/typescript-api/products-stock/multi-channel-stock-location-strategy#multichannelstocklocationstrategy'>MultiChannelStockLocationStrategy</a>.
+The DefaultStockLocationStrategy was the default implementation of the <DocsLink href="/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy">StockLocationStrategy</DocsLink>
+prior to the introduction of the <DocsLink href="/reference/typescript-api/products-stock/multi-channel-stock-location-strategy#multichannelstocklocationstrategy">MultiChannelStockLocationStrategy</DocsLink>.
 It assumes only a single StockLocation and that all stock is allocated from that location. When
 more than one StockLocation or Channel is used, it will not behave as expected.

package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx CHANGED Viewed

@@ -2,19 +2,15 @@
 title: "MultiChannelStockLocationStrategy"
 generated: true
 ---
-## MultiChannelStockLocationStrategy
 <GenerationInfo sourceFile="packages/core/src/config/catalog/multi-channel-stock-location-strategy.ts" sourceLine="32" packageName="@vendure/core" since="3.1.0" />
-The MultiChannelStockLocationStrategy is an implementation of the <a href='/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy'>StockLocationStrategy</a>.
+The MultiChannelStockLocationStrategy is an implementation of the <DocsLink href="/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy">StockLocationStrategy</DocsLink>.
 which is suitable for both single- and multichannel setups. It takes into account the active
 channel when determining stock levels, and also ensures that allocations are made only against
 stock locations which are associated with the active channel.
 This strategy became the default in Vendure 3.1.0. If you want to use the previous strategy which
-does not take channels into account, update your VendureConfig to use to <a href='/reference/typescript-api/products-stock/default-stock-location-strategy#defaultstocklocationstrategy'>DefaultStockLocationStrategy</a>.
+does not take channels into account, update your VendureConfig to use to <DocsLink href="/reference/typescript-api/products-stock/default-stock-location-strategy#defaultstocklocationstrategy">DefaultStockLocationStrategy</DocsLink>.
 ```ts title="Signature"
 class MultiChannelStockLocationStrategy extends BaseStockLocationStrategy {

package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "ProductVariantPriceCalculationStrategy"
 generated: true
 ---
-## ProductVariantPriceCalculationStrategy
 <GenerationInfo sourceFile="packages/core/src/config/catalog/product-variant-price-calculation-strategy.ts" sourceLine="23" packageName="@vendure/core" />
 Defines how ProductVariant are calculated based on the input price, tax zone and current request context.
@@ -36,13 +32,9 @@ interface ProductVariantPriceCalculationStrategy extends InjectableStrategy {
 </div>
-## ProductVariantPriceCalculationArgs
 <GenerationInfo sourceFile="packages/core/src/config/catalog/product-variant-price-calculation-strategy.ts" sourceLine="36" packageName="@vendure/core" />
-The arguments passed the `calculate` method of the configured <a href='/reference/typescript-api/products-stock/product-variant-price-calculation-strategy#productvariantpricecalculationstrategy'>ProductVariantPriceCalculationStrategy</a>.
+The arguments passed the `calculate` method of the configured <DocsLink href="/reference/typescript-api/products-stock/product-variant-price-calculation-strategy#productvariantpricecalculationstrategy">ProductVariantPriceCalculationStrategy</DocsLink>.
 The `productVariant` argument was added in v2.1.0.

package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "StockDisplayStrategy"
 generated: true
 ---
-## StockDisplayStrategy
 <GenerationInfo sourceFile="packages/core/src/config/catalog/stock-display-strategy.ts" sourceLine="21" packageName="@vendure/core" />
 Defines how the `ProductVariant.stockLevel` value is obtained. It is usually not desirable

package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx CHANGED Viewed

@@ -2,16 +2,12 @@
 title: "StockLocationStrategy"
 generated: true
 ---
-## StockLocationStrategy
 <GenerationInfo sourceFile="packages/core/src/config/catalog/stock-location-strategy.ts" sourceLine="55" packageName="@vendure/core" since="2.0.0" />
-The StockLocationStrategy is responsible for determining which <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>s
-should be used to fulfill an <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a> and how much stock should be allocated
+The StockLocationStrategy is responsible for determining which <DocsLink href="/reference/typescript-api/entities/stock-location#stocklocation">StockLocation</DocsLink>s
+should be used to fulfill an <DocsLink href="/reference/typescript-api/entities/order-line#orderline">OrderLine</DocsLink> and how much stock should be allocated
 from each location. It is also used to determine the available stock for a given
-<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>.
+<DocsLink href="/reference/typescript-api/entities/product-variant#productvariant">ProductVariant</DocsLink>.
 :::info
@@ -92,14 +88,10 @@ of an OrderLine which has already been fulfilled.
 </div>
-## AvailableStock
 <GenerationInfo sourceFile="packages/core/src/config/catalog/stock-location-strategy.ts" sourceLine="18" packageName="@vendure/core" since="2.0.0" />
 The overall available stock for a ProductVariant as determined by the logic of the
-<a href='/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy'>StockLocationStrategy</a>'s `getAvailableStock` method.
+<DocsLink href="/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy">StockLocationStrategy</DocsLink>'s `getAvailableStock` method.
 ```ts title="Signature"
 interface AvailableStock {
@@ -123,10 +115,6 @@ interface AvailableStock {
 </div>
-## LocationWithQuantity
 <GenerationInfo sourceFile="packages/core/src/config/catalog/stock-location-strategy.ts" sourceLine="32" packageName="@vendure/core" since="2.0.0" />
 Returned by the `StockLocationStrategy` methods to indicate how much stock from each

package/docs/reference/typescript-api/promotions/facet-value-checker.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "FacetValueChecker"
 generated: true
 ---
-## FacetValueChecker
 <GenerationInfo sourceFile="packages/core/src/service/helpers/facet-value-checker/facet-value-checker.ts" sourceLine="53" packageName="@vendure/core" />
 The FacetValueChecker is a helper class used to determine whether a given OrderLine consists
@@ -69,9 +65,9 @@ class FacetValueChecker implements OnModuleInit {
 <MemberInfo kind="method" type={`(orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, facetValueIds: <a href='/reference/typescript-api/common/id#id'>ID</a>[], ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<boolean>`}   />
-Checks a given <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a> against the facetValueIds and returns
-`true` if the associated <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a> & <a href='/reference/typescript-api/entities/product#product'>Product</a> together
-have *all* the specified <a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>s.
+Checks a given <DocsLink href="/reference/typescript-api/entities/order-line#orderline">OrderLine</DocsLink> against the facetValueIds and returns
+`true` if the associated <DocsLink href="/reference/typescript-api/entities/product-variant#productvariant">ProductVariant</DocsLink> & <DocsLink href="/reference/typescript-api/entities/product#product">Product</DocsLink> together
+have *all* the specified <DocsLink href="/reference/typescript-api/entities/facet-value#facetvalue">FacetValue</DocsLink>s.
 </div>

package/docs/reference/typescript-api/promotions/promotion-action.mdx CHANGED Viewed

@@ -2,14 +2,10 @@
 title: "Promotion Action"
 generated: true
 ---
-## PromotionAction
 <GenerationInfo sourceFile="packages/core/src/config/promotion/promotion-action.ts" sourceLine="281" packageName="@vendure/core" />
-An abstract class which is extended by <a href='/reference/typescript-api/promotions/promotion-action#promotionitemaction'>PromotionItemAction</a>, <a href='/reference/typescript-api/promotions/promotion-action#promotionorderaction'>PromotionOrderAction</a>,
-and <a href='/reference/typescript-api/promotions/promotion-action#promotionshippingaction'>PromotionShippingAction</a>.
+An abstract class which is extended by <DocsLink href="/reference/typescript-api/promotions/promotion-action#promotionitemaction">PromotionItemAction</DocsLink>, <DocsLink href="/reference/typescript-api/promotions/promotion-action#promotionorderaction">PromotionOrderAction</DocsLink>,
+and <DocsLink href="/reference/typescript-api/promotions/promotion-action#promotionshippingaction">PromotionShippingAction</DocsLink>.
 ```ts title="Signature"
 class PromotionAction<T extends ConfigArgs = ConfigArgs, U extends PromotionCondition[] | undefined = any> extends ConfigurableOperationDef<T> {
@@ -28,7 +24,7 @@ class PromotionAction<T extends ConfigArgs = ConfigArgs, U extends PromotionCond
 <MemberInfo kind="property" type={`number`} default={`0`}   />
 Used to determine the order of application of multiple Promotions
-on the same Order. See the <a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a> `priorityScore` field for
+on the same Order. See the <DocsLink href="/reference/typescript-api/entities/promotion#promotion">Promotion</DocsLink> `priorityScore` field for
 more information.
 ### constructor
@@ -38,13 +34,9 @@ more information.
 </div>
-## PromotionItemAction
 <GenerationInfo sourceFile="packages/core/src/config/promotion/promotion-action.ts" sourceLine="354" packageName="@vendure/core" />
-Represents a PromotionAction which applies to individual <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>s.
+Represents a PromotionAction which applies to individual <DocsLink href="/reference/typescript-api/entities/order-line#orderline">OrderLine</DocsLink>s.
 *Example*
@@ -79,13 +71,9 @@ class PromotionItemAction<T extends ConfigArgs = ConfigArgs, U extends Array<Pro
 </div>
-## PromotionOrderAction
 <GenerationInfo sourceFile="packages/core/src/config/promotion/promotion-action.ts" sourceLine="464" packageName="@vendure/core" />
-Represents a PromotionAction which applies to the <a href='/reference/typescript-api/entities/order#order'>Order</a> as a whole.
+Represents a PromotionAction which applies to the <DocsLink href="/reference/typescript-api/entities/order#order">Order</DocsLink> as a whole.
 *Example*
@@ -120,10 +108,6 @@ class PromotionOrderAction<T extends ConfigArgs = ConfigArgs, U extends Promotio
 </div>
-## PromotionShippingAction
 <GenerationInfo sourceFile="packages/core/src/config/promotion/promotion-action.ts" sourceLine="506" packageName="@vendure/core" />
 Represents a PromotionAction which applies to the shipping cost of an Order.
@@ -147,10 +131,6 @@ class PromotionShippingAction<T extends ConfigArgs = ConfigArgs, U extends Promo
 </div>
-## ExecutePromotionItemActionFn
 <GenerationInfo sourceFile="packages/core/src/config/promotion/promotion-action.ts" sourceLine="72" packageName="@vendure/core" />
 The function which is used by a PromotionItemAction to calculate the
@@ -165,10 +145,6 @@ type ExecutePromotionItemActionFn<T extends ConfigArgs, U extends Array<Promotio
     promotion: Promotion,
 ) => number | Promise<number>
 ```
-## ExecutePromotionLineActionFn
 <GenerationInfo sourceFile="packages/core/src/config/promotion/promotion-action.ts" sourceLine="88" packageName="@vendure/core" />
 The function which is used by a PromotionLineAction to calculate the
@@ -183,10 +159,6 @@ type ExecutePromotionLineActionFn<T extends ConfigArgs, U extends Array<Promotio
     promotion: Promotion,
 ) => number | Promise<number>
 ```
-## ExecutePromotionOrderActionFn
 <GenerationInfo sourceFile="packages/core/src/config/promotion/promotion-action.ts" sourceLine="104" packageName="@vendure/core" />
 The function which is used by a PromotionOrderAction to calculate the
@@ -201,10 +173,6 @@ type ExecutePromotionOrderActionFn<T extends ConfigArgs, U extends Array<Promoti
     promotion: Promotion,
 ) => number | Promise<number>
 ```
-## ExecutePromotionShippingActionFn
 <GenerationInfo sourceFile="packages/core/src/config/promotion/promotion-action.ts" sourceLine="120" packageName="@vendure/core" />
 The function which is used by a PromotionOrderAction to calculate the
@@ -220,10 +188,6 @@ type ExecutePromotionShippingActionFn<T extends ConfigArgs, U extends Array<Prom
     promotion: Promotion,
 ) => number | Promise<number>
 ```
-## PromotionActionSideEffectFn
 <GenerationInfo sourceFile="packages/core/src/config/promotion/promotion-action.ts" sourceLine="141" packageName="@vendure/core" since="1.8.0" experimental="true" />
 The signature of a PromotionAction's side-effect functions `onActivate` and `onDeactivate`.
@@ -236,13 +200,9 @@ type PromotionActionSideEffectFn<T extends ConfigArgs> = (
     promotion: Promotion,
 ) => void | Promise<void>
 ```
-## PromotionActionConfig
 <GenerationInfo sourceFile="packages/core/src/config/promotion/promotion-action.ts" sourceLine="155" packageName="@vendure/core" />
-Configuration for all types of <a href='/reference/typescript-api/promotions/promotion-action#promotionaction'>PromotionAction</a>.
+Configuration for all types of <DocsLink href="/reference/typescript-api/promotions/promotion-action#promotionaction">PromotionAction</DocsLink>.
 ```ts title="Signature"
 interface PromotionActionConfig<T extends ConfigArgs, U extends Array<PromotionCondition<any>> | undefined> extends ConfigurableOperationDefOptions<T> {
@@ -263,7 +223,7 @@ interface PromotionActionConfig<T extends ConfigArgs, U extends Array<PromotionC
 <MemberInfo kind="property" type={`number`} default={`0`}   />
 Used to determine the order of application of multiple Promotions
-on the same Order. See the <a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a> `priorityScore` field for
+on the same Order. See the <DocsLink href="/reference/typescript-api/entities/promotion#promotion">Promotion</DocsLink> `priorityScore` field for
 more information.
 ### conditions
@@ -293,13 +253,9 @@ Used to reverse or clean up any side effects executed as part of the `onActivate
 </div>
-## PromotionItemActionConfig
 <GenerationInfo sourceFile="packages/core/src/config/promotion/promotion-action.ts" sourceLine="209" packageName="@vendure/core" />
-Configuration for a <a href='/reference/typescript-api/promotions/promotion-action#promotionitemaction'>PromotionItemAction</a>
+Configuration for a <DocsLink href="/reference/typescript-api/promotions/promotion-action#promotionitemaction">PromotionItemAction</DocsLink>
 ```ts title="Signature"
 interface PromotionItemActionConfig<T extends ConfigArgs, U extends PromotionCondition[]> extends PromotionActionConfig<T, U> {
@@ -322,13 +278,9 @@ the OrderLine, i.e. the number should be negative.
 </div>
-## PromotionLineActionConfig
 <GenerationInfo sourceFile="packages/core/src/config/promotion/promotion-action.ts" sourceLine="227" packageName="@vendure/core" />
-Configuration for a <a href='/reference/typescript-api/promotions/promotion-action#promotionlineaction'>PromotionLineAction</a>
+Configuration for a <DocsLink href="/reference/typescript-api/promotions/promotion-action#promotionlineaction">PromotionLineAction</DocsLink>
 ```ts title="Signature"
 interface PromotionLineActionConfig<T extends ConfigArgs, U extends PromotionCondition[]> extends PromotionActionConfig<T, U> {
@@ -351,10 +303,6 @@ the OrderLine, i.e. the number should be negative.
 </div>
-## PromotionOrderActionConfig
 <GenerationInfo sourceFile="packages/core/src/config/promotion/promotion-action.ts" sourceLine="244" packageName="@vendure/core" />
@@ -380,10 +328,6 @@ the Order, i.e. the number should be negative.
 </div>
-## PromotionShippingActionConfig
 <GenerationInfo sourceFile="packages/core/src/config/promotion/promotion-action.ts" sourceLine="261" packageName="@vendure/core" />
@@ -409,13 +353,9 @@ the Shipping, i.e. the number should be negative.
 </div>
-## PromotionLineAction
 <GenerationInfo sourceFile="packages/core/src/config/promotion/promotion-action.ts" sourceLine="409" packageName="@vendure/core" />
-Represents a PromotionAction which applies to individual <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>s.
+Represents a PromotionAction which applies to individual <DocsLink href="/reference/typescript-api/entities/order-line#orderline">OrderLine</DocsLink>s.
 The difference from PromotionItemAction is that it applies regardless of the Quantity of the OrderLine.
 *Example*

package/docs/reference/typescript-api/promotions/promotion-condition.mdx CHANGED Viewed

@@ -2,13 +2,9 @@
 title: "Promotion Condition"
 generated: true
 ---
-## PromotionCondition
 <GenerationInfo sourceFile="packages/core/src/config/promotion/promotion-condition.ts" sourceLine="66" packageName="@vendure/core" />
-PromotionConditions are used to create <a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>s. The purpose of a PromotionCondition
+PromotionConditions are used to create <DocsLink href="/reference/typescript-api/entities/promotion#promotion">Promotion</DocsLink>s. The purpose of a PromotionCondition
 is to check the order against a particular predicate function (the `check` function) and to return
 `true` if the Order satisfies the condition, or `false` if it does not.
@@ -31,7 +27,7 @@ class PromotionCondition<T extends ConfigArgs = ConfigArgs, C extends string = s
 <MemberInfo kind="property" type={`number`} default={`0`}   />
 Used to determine the order of application of multiple Promotions
-on the same Order. See the <a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a> `priorityScore` field for
+on the same Order. See the <DocsLink href="/reference/typescript-api/entities/promotion#promotion">Promotion</DocsLink> `priorityScore` field for
 more information.
 ### code
@@ -48,14 +44,10 @@ more information.
 <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, args: ConfigArg[], promotion: <a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>) => Promise<R>`}   />
 This is the function which contains the conditional logic to decide whether
-a Promotion should apply to an Order. See <a href='/reference/typescript-api/promotions/promotion-condition#checkpromotionconditionfn'>CheckPromotionConditionFn</a>.
+a Promotion should apply to an Order. See <DocsLink href="/reference/typescript-api/promotions/promotion-condition#checkpromotionconditionfn">CheckPromotionConditionFn</DocsLink>.
 </div>
-## PromotionConditionConfig
 <GenerationInfo sourceFile="packages/core/src/config/promotion/promotion-condition.ts" sourceLine="46" packageName="@vendure/core" />
 This object is used to configure a PromotionCondition.
@@ -91,13 +83,9 @@ interface PromotionConditionConfig<T extends ConfigArgs, C extends string, R ext
 </div>
-## CheckPromotionConditionFn
 <GenerationInfo sourceFile="packages/core/src/config/promotion/promotion-condition.ts" sourceLine="31" packageName="@vendure/core" />
-A function which checks whether or not a given <a href='/reference/typescript-api/entities/order#order'>Order</a> satisfies the <a href='/reference/typescript-api/promotions/promotion-condition#promotioncondition'>PromotionCondition</a>.
+A function which checks whether or not a given <DocsLink href="/reference/typescript-api/entities/order#order">Order</DocsLink> satisfies the <DocsLink href="/reference/typescript-api/promotions/promotion-condition#promotioncondition">PromotionCondition</DocsLink>.
 The function should return either a `boolean` or and plain object type:

package/docs/reference/typescript-api/promotions/promotion-options.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "PromotionOptions"
 generated: true
 ---
-## PromotionOptions
 <GenerationInfo sourceFile="packages/core/src/config/vendure-config.ts" sourceLine="784" packageName="@vendure/core" />

package/docs/reference/typescript-api/request/allow-decorator.mdx CHANGED Viewed

@@ -2,14 +2,10 @@
 title: "Allow Decorator"
 generated: true
 ---
-## Allow
 <GenerationInfo sourceFile="packages/core/src/api/decorators/allow.decorator.ts" sourceLine="51" packageName="@vendure/core" />
 Attaches metadata to the resolver defining which permissions are required to execute the
-operation, using one or more <a href='/reference/typescript-api/common/permission#permission'>Permission</a> values.
+operation, using one or more <DocsLink href="/reference/typescript-api/common/permission#permission">Permission</DocsLink> values.
 When multiple permissions are specified, the user needs only **one** of them (OR logic).
 This is useful for operations that can be performed by users with different permission sets.

package/docs/reference/typescript-api/request/api-decorator.mdx CHANGED Viewed

@@ -2,17 +2,13 @@
 title: "Api Decorator"
 generated: true
 ---
-## Api
 <GenerationInfo sourceFile="packages/core/src/api/decorators/api.decorator.ts" sourceLine="26" packageName="@vendure/core" />
 Resolver param decorator which returns which Api the request came though.
 This is useful because sometimes the same resolver will have different behaviour
 depending whether it is being called from the shop API or the admin API.
-Returns a string of type <a href='/reference/typescript-api/request/api-type#apitype'>ApiType</a>.
+Returns a string of type <DocsLink href="/reference/typescript-api/request/api-type#apitype">ApiType</DocsLink>.
 *Example*

package/docs/reference/typescript-api/request/api-type.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "ApiType"
 generated: true
 ---
-## ApiType
 <GenerationInfo sourceFile="packages/core/src/api/common/get-api-type.ts" sourceLine="9" packageName="@vendure/core" />
 Which of the GraphQL APIs the current request came via.

package/docs/reference/typescript-api/request/ctx-decorator.mdx CHANGED Viewed

@@ -2,13 +2,9 @@
 title: "Ctx Decorator"
 generated: true
 ---
-## Ctx
 <GenerationInfo sourceFile="packages/core/src/api/decorators/request-context.decorator.ts" sourceLine="23" packageName="@vendure/core" />
-Resolver param decorator which extracts the <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> from the incoming
+Resolver param decorator which extracts the <DocsLink href="/reference/typescript-api/request/request-context#requestcontext">RequestContext</DocsLink> from the incoming
 request object.
 *Example*

package/docs/reference/typescript-api/request/relations-decorator.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "Relations Decorator"
 generated: true
 ---
-## Relations
 <GenerationInfo sourceFile="packages/core/src/api/decorators/relations.decorator.ts" sourceLine="136" packageName="@vendure/core" since="1.6.0" />
 Resolver param decorator which returns an array of relation paths which can be passed through
@@ -61,7 +57,7 @@ then the value of `relations` will be
 ['customer', 'lines'']
 ```
 The `'customer'` comes from the fact that the query is nesting the "customer" object, and the `'lines'` is taken
-from the `Order` entity's `totalQuantity` property, which uses <a href='/reference/typescript-api/data-access/calculated#calculated'>Calculated</a> decorator and defines those relations as dependencies
+from the `Order` entity's `totalQuantity` property, which uses <DocsLink href="/reference/typescript-api/data-access/calculated#calculated">Calculated</DocsLink> decorator and defines those relations as dependencies
 for deriving the calculated value.
 ## Depth

package/docs/reference/typescript-api/request/request-context-service.mdx CHANGED Viewed

@@ -2,13 +2,9 @@
 title: "RequestContextService"
 generated: true
 ---
-## RequestContextService
 <GenerationInfo sourceFile="packages/core/src/service/helpers/request-context/request-context.service.ts" sourceLine="25" packageName="@vendure/core" />
-Creates new <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> instances.
+Creates new <DocsLink href="/reference/typescript-api/request/request-context#requestcontext">RequestContext</DocsLink> instances.
 ```ts title="Signature"
 class RequestContextService {

package/docs/reference/typescript-api/request/request-context.mdx CHANGED Viewed

@@ -2,20 +2,16 @@
 title: "RequestContext"
 generated: true
 ---
-## RequestContext
 <GenerationInfo sourceFile="packages/core/src/api/common/request-context.ts" sourceLine="179" packageName="@vendure/core" />
 The RequestContext holds information relevant to the current request, which may be
 required at various points of the stack.
-It is a good practice to inject the RequestContext (using the <a href='/reference/typescript-api/request/ctx-decorator#ctx'>Ctx</a> decorator) into
+It is a good practice to inject the RequestContext (using the <DocsLink href="/reference/typescript-api/request/ctx-decorator#ctx">Ctx</DocsLink> decorator) into
 _all_ resolvers & REST handler, and then pass it through to the service layer.
 This allows the service layer to access information about the current user, the active language,
-the active Channel, and so on. In addition, the <a href='/reference/typescript-api/data-access/transactional-connection#transactionalconnection'>TransactionalConnection</a> relies on the
+the active Channel, and so on. In addition, the <DocsLink href="/reference/typescript-api/data-access/transactional-connection#transactionalconnection">TransactionalConnection</DocsLink> relies on the
 presence of the RequestContext object in order to correctly handle per-request database transactions.
 The RequestContext also provides mechanisms for managing the database replication mode via the
@@ -75,7 +71,7 @@ class RequestContext {
 Creates an "empty" RequestContext object. This is only intended to be used
 when a service method must be called outside the normal request-response
 cycle, e.g. when programmatically populating data. Usually a better alternative
-is to use the <a href='/reference/typescript-api/request/request-context-service#requestcontextservice'>RequestContextService</a> `create()` method, which allows more control
+is to use the <DocsLink href="/reference/typescript-api/request/request-context-service#requestcontextservice">RequestContextService</DocsLink> `create()` method, which allows more control
 over the resulting RequestContext object.
 ### deserialize
@@ -121,7 +117,7 @@ ctx.userHasAllPermissions([Permission.ReadProduct, Permission.UpdateProduct]);
 Serializes the RequestContext object into a JSON-compatible simple object.
 This is useful when you need to send a RequestContext object to another
-process, e.g. to pass it to the Job Queue via the <a href='/reference/typescript-api/job-queue/job-queue-service#jobqueueservice'>JobQueueService</a>.
+process, e.g. to pass it to the Job Queue via the <DocsLink href="/reference/typescript-api/job-queue/job-queue-service#jobqueueservice">JobQueueService</DocsLink>.
 ### copy
 <MemberInfo kind="method" type={`() => <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>`}   />
@@ -143,7 +139,7 @@ Signals which API this request was received by, e.g. `admin` or `shop`.
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>`}   />
-The active <a href='/reference/typescript-api/entities/channel#channel'>Channel</a> of this request.
+The active <DocsLink href="/reference/typescript-api/entities/channel#channel">Channel</DocsLink> of this request.
 ### channelId
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/id#id'>ID</a>`}   />