@vendure/docs 0.0.0-202601201808 → 0.0.0-202601211028

package/docs/reference/typescript-api/shipping/shipping-calculator.mdx

@@ -2,13 +2,9 @@
 title: "ShippingCalculator"
 generated: true
 ---
-
-
-## ShippingCalculator
-
 <GenerationInfo sourceFile="packages/core/src/config/shipping-method/shipping-calculator.ts" sourceLine="48" packageName="@vendure/core" />
 
-The ShippingCalculator is used by a <a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a> to calculate the price of shipping on a given <a href='/reference/typescript-api/entities/order#order'>Order</a>.
+The ShippingCalculator is used by a <DocsLink href="/reference/typescript-api/entities/shipping-method#shippingmethod">ShippingMethod</DocsLink> to calculate the price of shipping on a given <DocsLink href="/reference/typescript-api/entities/order#order">Order</DocsLink>.
 
 *Example*
 
@@ -41,7 +37,7 @@ class ShippingCalculator<T extends ConfigArgs = ConfigArgs> extends Configurable
     constructor(config: ShippingCalculatorConfig<T>)
 }
 ```
-* Extends: <code><a href='/reference/typescript-api/configurable-operation-def/#configurableoperationdef'>ConfigurableOperationDef</a>&#60;T&#62;</code>
+* Extends: <code><a href='/reference/typescript-api/configurable-operation-def/#configurableoperationdef'>ConfigurableOperationDef</a><T></code>
 
 
 
@@ -49,19 +45,15 @@ class ShippingCalculator<T extends ConfigArgs = ConfigArgs> extends Configurable
 
 ### constructor
 
-<MemberInfo kind="method" type={`(config: ShippingCalculatorConfig&#60;T&#62;) => ShippingCalculator`}   />
+<MemberInfo kind="method" type={`(config: ShippingCalculatorConfig<T>) => ShippingCalculator`}   />
 
 
 
 
 </div>
-
-
-## ShippingCalculationResult
-
 <GenerationInfo sourceFile="packages/core/src/config/shipping-method/shipping-calculator.ts" sourceLine="79" packageName="@vendure/core" />
 
-The return value of the <a href='/reference/typescript-api/shipping/shipping-calculator#calculateshippingfn'>CalculateShippingFn</a>.
+The return value of the <DocsLink href="/reference/typescript-api/shipping/shipping-calculator#calculateshippingfn">CalculateShippingFn</DocsLink>.
 
 ```ts title="Signature"
 interface ShippingCalculationResult {
@@ -91,7 +83,7 @@ Whether or not the given price already includes taxes.
 The tax rate applied to the shipping price.
 ### metadata
 
-<MemberInfo kind="property" type={`Record&#60;string, any&#62;`}   />
+<MemberInfo kind="property" type={`Record<string, any>`}   />
 
 Arbitrary metadata may be returned from the calculation function. This can be used
 e.g. to return data on estimated delivery times or any other data which may be
@@ -99,16 +91,12 @@ needed in the storefront application when listing eligible shipping methods.
 
 
 </div>
-
-
-## CalculateShippingFn
-
 <GenerationInfo sourceFile="packages/core/src/config/shipping-method/shipping-calculator.ts" sourceLine="119" packageName="@vendure/core" />
 
-A function which implements the specific shipping calculation logic. It takes an <a href='/reference/typescript-api/entities/order#order'>Order</a> and
+A function which implements the specific shipping calculation logic. It takes an <DocsLink href="/reference/typescript-api/entities/order#order">Order</DocsLink> and
 an arguments object and should return the shipping price as an integer in cents.
 
-Should return a <a href='/reference/typescript-api/shipping/shipping-calculator#shippingcalculationresult'>ShippingCalculationResult</a> object.
+Should return a <DocsLink href="/reference/typescript-api/shipping/shipping-calculator#shippingcalculationresult">ShippingCalculationResult</DocsLink> object.
 
 ```ts title="Signature"
 type CalculateShippingFn<T extends ConfigArgs> = (

package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx

@@ -2,13 +2,9 @@
 title: "ShippingEligibilityCheckerConfig"
 generated: true
 ---
-
-
-## ShippingEligibilityCheckerConfig
-
 <GenerationInfo sourceFile="packages/core/src/config/shipping-method/shipping-eligibility-checker.ts" sourceLine="23" packageName="@vendure/core" />
 
-Configuration passed into the constructor of a <a href='/reference/typescript-api/shipping/shipping-eligibility-checker#shippingeligibilitychecker'>ShippingEligibilityChecker</a> to
+Configuration passed into the constructor of a <DocsLink href="/reference/typescript-api/shipping/shipping-eligibility-checker#shippingeligibilitychecker">ShippingEligibilityChecker</DocsLink> to
 configure its behavior.
 
 ```ts title="Signature"
@@ -17,7 +13,7 @@ interface ShippingEligibilityCheckerConfig<T extends ConfigArgs> extends Configu
     shouldRunCheck?: ShouldRunCheckFn<T>;
 }
 ```
-* Extends: <code><a href='/reference/typescript-api/configurable-operation-def/configurable-operation-def-options#configurableoperationdefoptions'>ConfigurableOperationDefOptions</a>&#60;T&#62;</code>
+* Extends: <code><a href='/reference/typescript-api/configurable-operation-def/configurable-operation-def-options#configurableoperationdefoptions'>ConfigurableOperationDefOptions</a><T></code>
 
 
 
@@ -25,12 +21,12 @@ interface ShippingEligibilityCheckerConfig<T extends ConfigArgs> extends Configu
 
 ### check
 
-<MemberInfo kind="property" type={`<a href='/reference/typescript-api/shipping/check-shipping-eligibility-checker-fn#checkshippingeligibilitycheckerfn'>CheckShippingEligibilityCheckerFn</a>&#60;T&#62;`}   />
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/shipping/check-shipping-eligibility-checker-fn#checkshippingeligibilitycheckerfn'>CheckShippingEligibilityCheckerFn</a><T>`}   />
 
 
 ### shouldRunCheck
 
-<MemberInfo kind="property" type={`<a href='/reference/typescript-api/shipping/should-run-check-fn#shouldruncheckfn'>ShouldRunCheckFn</a>&#60;T&#62;`}   />
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/shipping/should-run-check-fn#shouldruncheckfn'>ShouldRunCheckFn</a><T>`}   />
 
 
 

package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx

@@ -2,14 +2,10 @@
 title: "ShippingEligibilityChecker"
 generated: true
 ---
-
-
-## ShippingEligibilityChecker
-
 <GenerationInfo sourceFile="packages/core/src/config/shipping-method/shipping-eligibility-checker.ts" sourceLine="50" packageName="@vendure/core" />
 
 The ShippingEligibilityChecker class is used to check whether an order qualifies for a
-given <a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>.
+given <DocsLink href="/reference/typescript-api/entities/shipping-method#shippingmethod">ShippingMethod</DocsLink>.
 
 *Example*
 
@@ -33,7 +29,7 @@ class ShippingEligibilityChecker<T extends ConfigArgs = ConfigArgs> extends Conf
     toJSON() => ;
 }
 ```
-* Extends: <code><a href='/reference/typescript-api/configurable-operation-def/#configurableoperationdef'>ConfigurableOperationDef</a>&#60;T&#62;</code>
+* Extends: <code><a href='/reference/typescript-api/configurable-operation-def/#configurableoperationdef'>ConfigurableOperationDef</a><T></code>
 
 
 
@@ -41,7 +37,7 @@ class ShippingEligibilityChecker<T extends ConfigArgs = ConfigArgs> extends Conf
 
 ### constructor
 
-<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/shipping/shipping-eligibility-checker-config#shippingeligibilitycheckerconfig'>ShippingEligibilityCheckerConfig</a>&#60;T&#62;) => ShippingEligibilityChecker`}   />
+<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/shipping/shipping-eligibility-checker-config#shippingeligibilitycheckerconfig'>ShippingEligibilityCheckerConfig</a><T>) => ShippingEligibilityChecker`}   />
 
 
 ### init

package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx

@@ -2,17 +2,13 @@
 title: "ShippingLineAssignmentStrategy"
 generated: true
 ---
-
-
-## ShippingLineAssignmentStrategy
-
 <GenerationInfo sourceFile="packages/core/src/config/shipping-method/shipping-line-assignment-strategy.ts" sourceLine="52" packageName="@vendure/core" since="2.0.0" />
 
-This strategy is used to assign a given <a href='/reference/typescript-api/entities/shipping-line#shippingline'>ShippingLine</a> to one or more <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>s of the Order.
+This strategy is used to assign a given <DocsLink href="/reference/typescript-api/entities/shipping-line#shippingline">ShippingLine</DocsLink> to one or more <DocsLink href="/reference/typescript-api/entities/order-line#orderline">OrderLine</DocsLink>s of the Order.
 This allows you to set multiple shipping methods for a single order, each assigned a different subset of
 OrderLines.
 
-The <a href='/reference/typescript-api/shipping/default-shipping-line-assignment-strategy#defaultshippinglineassignmentstrategy'>DefaultShippingLineAssignmentStrategy</a> simply assigns _all_ OrderLines, so is suitable for the
+The <DocsLink href="/reference/typescript-api/shipping/default-shipping-line-assignment-strategy#defaultshippinglineassignmentstrategy">DefaultShippingLineAssignmentStrategy</DocsLink> simply assigns _all_ OrderLines, so is suitable for the
 most common scenario of a single shipping method per Order.
 
 :::info
@@ -66,7 +62,7 @@ interface ShippingLineAssignmentStrategy extends InjectableStrategy {
 
 ### assignShippingLineToOrderLines
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, shippingLine: <a href='/reference/typescript-api/entities/shipping-line#shippingline'>ShippingLine</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>[] | Promise&#60;<a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>[]&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, shippingLine: <a href='/reference/typescript-api/entities/shipping-line#shippingline'>ShippingLine</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>[] | Promise<<a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>[]>`}   />
 
 
 

package/docs/reference/typescript-api/shipping/shipping-options.mdx

@@ -2,10 +2,6 @@
 title: "ShippingOptions"
 generated: true
 ---
-
-
-## ShippingOptions
-
 <GenerationInfo sourceFile="packages/core/src/config/vendure-config.ts" sourceLine="800" packageName="@vendure/core" />
 
 
@@ -25,36 +21,36 @@ interface ShippingOptions {
 
 ### shippingEligibilityCheckers
 
-<MemberInfo kind="property" type={`Array&#60;<a href='/reference/typescript-api/shipping/shipping-eligibility-checker#shippingeligibilitychecker'>ShippingEligibilityChecker</a>&#60;any&#62;&#62;`}   />
+<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/shipping/shipping-eligibility-checker#shippingeligibilitychecker'>ShippingEligibilityChecker</a><any>>`}   />
 
 An array of available ShippingEligibilityCheckers for use in configuring ShippingMethods
 ### shippingCalculators
 
-<MemberInfo kind="property" type={`Array&#60;<a href='/reference/typescript-api/shipping/shipping-calculator#shippingcalculator'>ShippingCalculator</a>&#60;any&#62;&#62;`}   />
+<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/shipping/shipping-calculator#shippingcalculator'>ShippingCalculator</a><any>>`}   />
 
 An array of available ShippingCalculators for use in configuring ShippingMethods
 ### shippingLineAssignmentStrategy
 
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/shipping/shipping-line-assignment-strategy#shippinglineassignmentstrategy'>ShippingLineAssignmentStrategy</a>`}  since="2.0.0"  />
 
-This strategy is used to assign a given <a href='/reference/typescript-api/entities/shipping-line#shippingline'>ShippingLine</a> to one or more <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>s of the Order.
+This strategy is used to assign a given <DocsLink href="/reference/typescript-api/entities/shipping-line#shippingline">ShippingLine</DocsLink> to one or more <DocsLink href="/reference/typescript-api/entities/order-line#orderline">OrderLine</DocsLink>s of the Order.
 This allows you to set multiple shipping methods for a single order, each assigned a different subset of
 OrderLines.
 ### customFulfillmentProcess
 
-<MemberInfo kind="property" type={`Array&#60;<a href='/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess'>FulfillmentProcess</a>&#60;any&#62;&#62;`}   />
+<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess'>FulfillmentProcess</a><any>>`}   />
 
 Allows the definition of custom states and transition logic for the fulfillment process state machine.
-Takes an array of objects implementing the <a href='/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess'>FulfillmentProcess</a> interface.
+Takes an array of objects implementing the <DocsLink href="/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess">FulfillmentProcess</DocsLink> interface.
 ### process
 
-<MemberInfo kind="property" type={`Array&#60;<a href='/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess'>FulfillmentProcess</a>&#60;any&#62;&#62;`} default={`<a href='/reference/typescript-api/fulfillment/fulfillment-process#defaultfulfillmentprocess'>defaultFulfillmentProcess</a>`}  since="2.0.0"  />
+<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess'>FulfillmentProcess</a><any>>`} default={`<a href='/reference/typescript-api/fulfillment/fulfillment-process#defaultfulfillmentprocess'>defaultFulfillmentProcess</a>`}  since="2.0.0"  />
 
 Allows the definition of custom states and transition logic for the fulfillment process state machine.
-Takes an array of objects implementing the <a href='/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess'>FulfillmentProcess</a> interface.
+Takes an array of objects implementing the <DocsLink href="/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess">FulfillmentProcess</DocsLink> interface.
 ### fulfillmentHandlers
 
-<MemberInfo kind="property" type={`Array&#60;<a href='/reference/typescript-api/fulfillment/fulfillment-handler#fulfillmenthandler'>FulfillmentHandler</a>&#60;any&#62;&#62;`}   />
+<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/fulfillment/fulfillment-handler#fulfillmenthandler'>FulfillmentHandler</a><any>>`}   />
 
 An array of available FulfillmentHandlers.
 

package/docs/reference/typescript-api/shipping/should-run-check-fn.mdx

@@ -2,10 +2,6 @@
 title: "ShouldRunCheckFn"
 generated: true
 ---
-
-
-## ShouldRunCheckFn
-
 <GenerationInfo sourceFile="packages/core/src/config/shipping-method/shipping-eligibility-checker.ts" sourceLine="173" packageName="@vendure/core" />
 
 An optional method which is used to decide whether to run the `check()` function.

package/docs/reference/typescript-api/state-machine/fsm.mdx

@@ -2,10 +2,6 @@
 title: "FSM"
 generated: true
 ---
-
-
-## FSM
-
 <GenerationInfo sourceFile="packages/core/src/common/finite-state-machine/finite-state-machine.ts" sourceLine="12" packageName="@vendure/core" />
 
 A simple type-safe finite state machine. This is used internally to control the Order process, ensuring that
@@ -27,7 +23,7 @@ class FSM<T extends string, Data = any> {
 
 ### constructor
 
-<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/state-machine/state-machine-config#statemachineconfig'>StateMachineConfig</a>&#60;T, Data&#62;, initialState: T) => FSM`}   />
+<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/state-machine/state-machine-config#statemachineconfig'>StateMachineConfig</a><T, Data>, initialState: T) => FSM`}   />
 
 
 ### initialState
@@ -42,7 +38,7 @@ class FSM<T extends string, Data = any> {
 
 ### transitionTo
 
-<MemberInfo kind="method" type={`(state: T, data: Data) => Promise&#60;{ finalize: () =&#62; Promise&#60;any&#62; }&#62;`}   />
+<MemberInfo kind="method" type={`(state: T, data: Data) => Promise<{ finalize: () => Promise<any> }>`}   />
 
 
 ### jumpTo

package/docs/reference/typescript-api/state-machine/state-machine-config.mdx

@@ -2,13 +2,9 @@
 title: "StateMachineConfig"
 generated: true
 ---
-
-
-## StateMachineConfig
-
 <GenerationInfo sourceFile="packages/core/src/common/finite-state-machine/types.ts" sourceLine="89" packageName="@vendure/core" />
 
-The config object used to instantiate a new <a href='/reference/typescript-api/state-machine/fsm#fsm'>FSM</a> instance.
+The config object used to instantiate a new <DocsLink href="/reference/typescript-api/state-machine/fsm#fsm">FSM</DocsLink> instance.
 
 ```ts title="Signature"
 interface StateMachineConfig<T extends string, Data = undefined> {
@@ -23,13 +19,13 @@ interface StateMachineConfig<T extends string, Data = undefined> {
 
 ### transitions
 
-<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>&#60;T&#62;`}   />
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a><T>`}   />
 
 Defines the available states of the state machine as well as the permitted
 transitions from one state to another.
 ### onTransitionStart
 
-<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a>&#60;T, Data&#62;`}   />
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a><T, Data>`}   />
 
 Called before a transition takes place. If the function resolves to `false` or a string, then the transition
 will be cancelled. In the case of a string, the string (error message) will be forwarded to the onError handler.
@@ -38,22 +34,18 @@ If this function returns a value resolving to `true` or `void` (no return value)
 will be permitted.
 ### onTransitionEnd
 
-<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a>&#60;T, Data&#62;`}   />
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a><T, Data>`}   />
 
 Called after a transition has taken place.
 ### onError
 
-<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a>&#60;T&#62;`}   />
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a><T>`}   />
 
 Called when a transition is prevented and the `onTransitionStart` handler has returned an
 error message.
 
 
 </div>
-
-
-## OnTransitionStartFn
-
 <GenerationInfo sourceFile="packages/core/src/common/finite-state-machine/types.ts" sourceLine="48" packageName="@vendure/core" />
 
 Called before a transition takes place. If the function resolves to `false` or a string, then the transition
@@ -69,10 +61,6 @@ type OnTransitionStartFn<T extends string, Data> = (
     data: Data,
 ) => boolean | string | void | Promise<boolean | string | void> | Observable<boolean | string | void>
 ```
-
-
-## OnTransitionErrorFn
-
 <GenerationInfo sourceFile="packages/core/src/common/finite-state-machine/types.ts" sourceLine="62" packageName="@vendure/core" />
 
 Called when a transition is prevented and the `onTransitionStart` handler has returned an
@@ -85,10 +73,6 @@ type OnTransitionErrorFn<T extends string> = (
     message?: string,
 ) => void | Promise<void> | Observable<void>
 ```
-
-
-## OnTransitionEndFn
-
 <GenerationInfo sourceFile="packages/core/src/common/finite-state-machine/types.ts" sourceLine="75" packageName="@vendure/core" />
 
 Called after a transition has taken place.

package/docs/reference/typescript-api/state-machine/transitions.mdx

@@ -2,14 +2,10 @@
 title: "Transitions"
 generated: true
 ---
-
-
-## Transitions
-
 <GenerationInfo sourceFile="packages/core/src/common/finite-state-machine/types.ts" sourceLine="30" packageName="@vendure/core" />
 
 A type which is used to define valid states and transitions for a state machine based
-on <a href='/reference/typescript-api/state-machine/fsm#fsm'>FSM</a>.
+on <DocsLink href="/reference/typescript-api/state-machine/fsm#fsm">FSM</DocsLink>.
 
 *Example*
 
@@ -30,7 +26,7 @@ const trafficLightTransitions: Transitions<LightColor> = {
 ```
 
 The `mergeStrategy` property defines how to handle the merging of states when one set of
-transitions is being merged with another (as in the case of defining a <a href='/reference/typescript-api/orders/order-process#orderprocess'>OrderProcess</a>)
+transitions is being merged with another (as in the case of defining a <DocsLink href="/reference/typescript-api/orders/order-process#orderprocess">OrderProcess</DocsLink>)
 
 ```ts title="Signature"
 type Transitions<State extends string, Target extends string = State> = {

package/docs/reference/typescript-api/tax/address-based-tax-zone-strategy.mdx

@@ -2,17 +2,13 @@
 title: "AddressBasedTaxZoneStrategy"
 generated: true
 ---
-
-
-## AddressBasedTaxZoneStrategy
-
 <GenerationInfo sourceFile="packages/core/src/config/tax/address-based-tax-zone-strategy.ts" sourceLine="40" packageName="@vendure/core" since="3.1.0" />
 
-Address based <a href='/reference/typescript-api/tax/tax-zone-strategy#taxzonestrategy'>TaxZoneStrategy</a> which tries to find the applicable <a href='/reference/typescript-api/entities/zone#zone'>Zone</a> based on the
+Address based <DocsLink href="/reference/typescript-api/tax/tax-zone-strategy#taxzonestrategy">TaxZoneStrategy</DocsLink> which tries to find the applicable <DocsLink href="/reference/typescript-api/entities/zone#zone">Zone</DocsLink> based on the
 country of the shipping address of the Order.
 This is useful for shops that do cross-border B2C orders and use the One-Stop-Shop (OSS) VAT scheme.
 
-Returns the default <a href='/reference/typescript-api/entities/channel#channel'>Channel</a>'s default tax zone if no applicable zone is found.
+Returns the default <DocsLink href="/reference/typescript-api/entities/channel#channel">Channel</DocsLink>'s default tax zone if no applicable zone is found.
 
 :::info
 

package/docs/reference/typescript-api/tax/default-tax-line-calculation-strategy.mdx

@@ -2,14 +2,10 @@
 title: "DefaultTaxLineCalculationStrategy"
 generated: true
 ---
-
-
-## DefaultTaxLineCalculationStrategy
-
 <GenerationInfo sourceFile="packages/core/src/config/tax/default-tax-line-calculation-strategy.ts" sourceLine="12" packageName="@vendure/core" />
 
-The default <a href='/reference/typescript-api/tax/tax-line-calculation-strategy#taxlinecalculationstrategy'>TaxLineCalculationStrategy</a> which applies a single TaxLine to the OrderLine
-based on the applicable <a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a>.
+The default <DocsLink href="/reference/typescript-api/tax/tax-line-calculation-strategy#taxlinecalculationstrategy">TaxLineCalculationStrategy</DocsLink> which applies a single TaxLine to the OrderLine
+based on the applicable <DocsLink href="/reference/typescript-api/entities/tax-rate#taxrate">TaxRate</DocsLink>.
 
 ```ts title="Signature"
 class DefaultTaxLineCalculationStrategy implements TaxLineCalculationStrategy {

package/docs/reference/typescript-api/tax/default-tax-zone-strategy.mdx

@@ -2,16 +2,12 @@
 title: "DefaultTaxZoneStrategy"
 generated: true
 ---
-
-
-## DefaultTaxZoneStrategy
-
 <GenerationInfo sourceFile="packages/core/src/config/tax/default-tax-zone-strategy.ts" sourceLine="15" packageName="@vendure/core" />
 
 A default method of determining Zone for tax calculations. The strategy simply returns the default
 tax zone of the Channel. In many cases you actually want to base the tax zone
 on the shipping or billing address of the Order, in which case you would use the
-<a href='/reference/typescript-api/tax/address-based-tax-zone-strategy#addressbasedtaxzonestrategy'>AddressBasedTaxZoneStrategy</a>.
+<DocsLink href="/reference/typescript-api/tax/address-based-tax-zone-strategy#addressbasedtaxzonestrategy">AddressBasedTaxZoneStrategy</DocsLink>.
 
 ```ts title="Signature"
 class DefaultTaxZoneStrategy implements TaxZoneStrategy {

package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx

@@ -2,15 +2,11 @@
 title: "TaxLineCalculationStrategy"
 generated: true
 ---
-
-
-## TaxLineCalculationStrategy
-
 <GenerationInfo sourceFile="packages/core/src/config/tax/tax-line-calculation-strategy.ts" sourceLine="29" packageName="@vendure/core" />
 
 This strategy defines how the TaxLines on OrderItems are calculated. By default,
-the <a href='/reference/typescript-api/tax/default-tax-line-calculation-strategy#defaulttaxlinecalculationstrategy'>DefaultTaxLineCalculationStrategy</a> is used, which directly applies
-a single TaxLine based on the applicable <a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a>.
+the <DocsLink href="/reference/typescript-api/tax/default-tax-line-calculation-strategy#defaulttaxlinecalculationstrategy">DefaultTaxLineCalculationStrategy</DocsLink> is used, which directly applies
+a single TaxLine based on the applicable <DocsLink href="/reference/typescript-api/entities/tax-rate#taxrate">TaxRate</DocsLink>.
 
 However, custom strategies may use any suitable method for calculating TaxLines.
 For example, a third-party tax API or a lookup of a custom tax table may be used.
@@ -35,7 +31,7 @@ interface TaxLineCalculationStrategy extends InjectableStrategy {
 
 ### calculate
 
-<MemberInfo kind="method" type={`(args: <a href='/reference/typescript-api/tax/tax-line-calculation-strategy#calculatetaxlinesargs'>CalculateTaxLinesArgs</a>) => TaxLine[] | Promise&#60;TaxLine[]&#62;`}   />
+<MemberInfo kind="method" type={`(args: <a href='/reference/typescript-api/tax/tax-line-calculation-strategy#calculatetaxlinesargs'>CalculateTaxLinesArgs</a>) => TaxLine[] | Promise<TaxLine[]>`}   />
 
 This method is called when calculating the Order prices. Since it will be called
 whenever an Order is modified in some way (adding/removing items, applying promotions,
@@ -45,10 +41,6 @@ calling external APIs when absolutely necessary.
 
 
 </div>
-
-
-## CalculateTaxLinesArgs
-
 <GenerationInfo sourceFile="packages/core/src/config/tax/tax-line-calculation-strategy.ts" sourceLine="47" packageName="@vendure/core" />
 
 

package/docs/reference/typescript-api/tax/tax-options.mdx

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

package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx

@@ -2,13 +2,9 @@
 title: "TaxZoneStrategy"
 generated: true
 ---
-
-
-## TaxZoneStrategy
-
 <GenerationInfo sourceFile="packages/core/src/config/tax/tax-zone-strategy.ts" sourceLine="28" packageName="@vendure/core" />
 
-Defines how the active <a href='/reference/typescript-api/entities/zone#zone'>Zone</a> is determined for the purposes of calculating taxes.
+Defines how the active <DocsLink href="/reference/typescript-api/entities/zone#zone">Zone</DocsLink> is determined for the purposes of calculating taxes.
 
 This strategy is used in 2 scenarios:
 
@@ -45,7 +41,7 @@ interface TaxZoneStrategy extends InjectableStrategy {
 
 ### determineTaxZone
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, zones: <a href='/reference/typescript-api/entities/zone#zone'>Zone</a>[], channel: <a href='/reference/typescript-api/entities/channel#channel'>Channel</a>, order?: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => <a href='/reference/typescript-api/entities/zone#zone'>Zone</a> | Promise&#60;<a href='/reference/typescript-api/entities/zone#zone'>Zone</a>&#62; | undefined`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, zones: <a href='/reference/typescript-api/entities/zone#zone'>Zone</a>[], channel: <a href='/reference/typescript-api/entities/channel#channel'>Channel</a>, order?: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => <a href='/reference/typescript-api/entities/zone#zone'>Zone</a> | Promise<<a href='/reference/typescript-api/entities/zone#zone'>Zone</a>> | undefined`}   />
 
 
 

package/docs/reference/typescript-api/telemetry/instrument.mdx

@@ -2,14 +2,10 @@
 title: "Instrument"
 generated: true
 ---
-
-
-## Instrument
-
 <GenerationInfo sourceFile="packages/core/src/common/instrument-decorator.ts" sourceLine="47" packageName="@vendure/core" since="3.3.0" />
 
 This decorator is used to apply instrumentation to a class. It is intended to be used in conjunction
-with an <a href='/reference/typescript-api/telemetry/instrumentation-strategy#instrumentationstrategy'>InstrumentationStrategy</a> which defines how the instrumentation should be applied.
+with an <DocsLink href="/reference/typescript-api/telemetry/instrumentation-strategy#instrumentationstrategy">InstrumentationStrategy</DocsLink> which defines how the instrumentation should be applied.
 
 In order for the instrumentation to be applied, the `VENDURE_ENABLE_INSTRUMENTATION` environment
 variable (exported from the `@vendure/core` package as `ENABLE_INSTRUMENTATION_ENV_VAR`) must be set to `true`.

package/docs/reference/typescript-api/telemetry/instrumentation-strategy.mdx

@@ -2,14 +2,10 @@
 title: "InstrumentationStrategy"
 generated: true
 ---
-
-
-## InstrumentationStrategy
-
 <GenerationInfo sourceFile="packages/core/src/config/system/instrumentation-strategy.ts" sourceLine="51" packageName="@vendure/core" since="3.3.0" />
 
 This interface is used to define a strategy for instrumenting methods of
-classes which are decorated with the <a href='/reference/typescript-api/telemetry/instrument#instrument'>Instrument</a> decorator.
+classes which are decorated with the <DocsLink href="/reference/typescript-api/telemetry/instrument#instrument">Instrument</DocsLink> decorator.
 
 ```ts title="Signature"
 interface InstrumentationStrategy extends InjectableStrategy {

package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx

@@ -2,14 +2,10 @@
 title: "WrappedMethodArgs"
 generated: true
 ---
-
-
-## WrappedMethodArgs
-
 <GenerationInfo sourceFile="packages/core/src/config/system/instrumentation-strategy.ts" sourceLine="13" packageName="@vendure/core" since="3.3.0" />
 
 The arguments that are passed to the `wrapMethod` method of the
-<a href='/reference/typescript-api/telemetry/instrumentation-strategy#instrumentationstrategy'>InstrumentationStrategy</a> interface.
+<DocsLink href="/reference/typescript-api/telemetry/instrumentation-strategy#instrumentationstrategy">InstrumentationStrategy</DocsLink> interface.
 
 ```ts title="Signature"
 interface WrappedMethodArgs {
@@ -30,7 +26,7 @@ interface WrappedMethodArgs {
 The instance of the class which is being instrumented.
 ### target
 
-<MemberInfo kind="property" type={`Type&#60;any&#62;`}   />
+<MemberInfo kind="property" type={`Type<any>`}   />
 
 The class which is being instrumented.
 ### methodName
@@ -45,7 +41,7 @@ The name of the method which is being instrumented.
 The arguments which are passed to the method.
 ### applyOriginalFunction
 
-<MemberInfo kind="property" type={`() =&#62; any | Promise&#60;any&#62;`}   />
+<MemberInfo kind="property" type={`() => any | Promise<any>`}   />
 
 A function which applies the original method and returns the result.
 This is used to call the original method after the instrumentation has

package/docs/reference/typescript-api/testing/create-error-result-guard.mdx

@@ -2,13 +2,9 @@
 title: "CreateErrorResultGuard"
 generated: true
 ---
-
-
-## createErrorResultGuard
-
 <GenerationInfo sourceFile="packages/testing/src/error-result-guard.ts" sourceLine="18" packageName="@vendure/testing" />
 
-Convenience method for creating an <a href='/reference/typescript-api/testing/error-result-guard#errorresultguard'>ErrorResultGuard</a>. Takes a predicate function which
+Convenience method for creating an <DocsLink href="/reference/typescript-api/testing/error-result-guard#errorresultguard">ErrorResultGuard</DocsLink>. Takes a predicate function which
 tests whether the input is considered successful (true) or an error result (false).
 
 Note that the resulting variable must _still_ be type annotated in order for the TypeScript
@@ -28,5 +24,5 @@ Parameters
 
 ### testFn
 
-<MemberInfo kind="parameter" type={`(input: T) =&#62; boolean`} />
+<MemberInfo kind="parameter" type={`(input: T) => boolean`} />