@vendure/docs 0.0.0-202601271334 → 0.0.0-202601281114

package/docs/reference/typescript-api/entities/stock-location.mdx

@@ -6,9 +6,9 @@ generated: true
 
 A StockLocation represents a physical location where stock is held. For example, a warehouse or a shop.
 
-When the stock of a <DocsLink href="/reference/typescript-api/entities/product-variant#productvariant">ProductVariant</DocsLink> is adjusted, the adjustment is applied to a specific StockLocation,
+When the stock of a [ProductVariant](/reference/typescript-api/entities/product-variant#productvariant) is adjusted, the adjustment is applied to a specific StockLocation,
 and the stockOnHand of that ProductVariant is updated accordingly. When there are multiple StockLocations
-configured, the <DocsLink href="/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy">StockLocationStrategy</DocsLink> is used to determine which StockLocation should be used for
+configured, the [StockLocationStrategy](/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy) is used to determine which StockLocation should be used for
 a given operation.
 
 ```ts title="Signature"
@@ -27,10 +27,10 @@ class StockLocation extends VendureEntity implements HasCustomFields, ChannelAwa
     stockMovements: StockMovement[];
 }
 ```
-* Extends: <DocsLink href="/reference/typescript-api/entities/vendure-entity#vendureentity">`VendureEntity`</DocsLink>
+* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
 
 
-* Implements: HasCustomFields, <DocsLink href="/reference/typescript-api/entities/interfaces#channelaware">`ChannelAware`</DocsLink>
+* Implements: HasCustomFields, [`ChannelAware`](/reference/typescript-api/entities/interfaces#channelaware)
 
 
 

package/docs/reference/typescript-api/entities/stock-movement.mdx

@@ -25,7 +25,7 @@ class StockMovement extends VendureEntity implements HasCustomFields {
     customFields: CustomStockMovementFields;
 }
 ```
-* Extends: <DocsLink href="/reference/typescript-api/entities/vendure-entity#vendureentity">`VendureEntity`</DocsLink>
+* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
 
 
 * Implements: HasCustomFields
@@ -70,7 +70,7 @@ class StockMovement extends VendureEntity implements HasCustomFields {
 <GenerationInfo sourceFile="packages/core/src/entity/stock-movement/allocation.entity.ts" sourceLine="17" packageName="@vendure/core" />
 
 An Allocation is created for each ProductVariant in an Order when the checkout is completed
-(as configured by the <DocsLink href="/reference/typescript-api/orders/stock-allocation-strategy#stockallocationstrategy">StockAllocationStrategy</DocsLink>. This prevents stock being sold twice.
+(as configured by the [StockAllocationStrategy](/reference/typescript-api/orders/stock-allocation-strategy#stockallocationstrategy). This prevents stock being sold twice.
 
 ```ts title="Signature"
 class Allocation extends StockMovement {
@@ -81,7 +81,7 @@ class Allocation extends StockMovement {
     orderLine: OrderLine;
 }
 ```
-* Extends: <DocsLink href="/reference/typescript-api/entities/stock-movement#stockmovement">`StockMovement`</DocsLink>
+* Extends: [`StockMovement`](/reference/typescript-api/entities/stock-movement#stockmovement)
 
 
 
@@ -117,7 +117,7 @@ class Cancellation extends StockMovement {
     orderLine: OrderLine;
 }
 ```
-* Extends: <DocsLink href="/reference/typescript-api/entities/stock-movement#stockmovement">`StockMovement`</DocsLink>
+* Extends: [`StockMovement`](/reference/typescript-api/entities/stock-movement#stockmovement)
 
 
 
@@ -154,7 +154,7 @@ class Release extends StockMovement {
     orderLine: OrderLine;
 }
 ```
-* Extends: <DocsLink href="/reference/typescript-api/entities/stock-movement#stockmovement">`StockMovement`</DocsLink>
+* Extends: [`StockMovement`](/reference/typescript-api/entities/stock-movement#stockmovement)
 
 
 
@@ -190,7 +190,7 @@ class Sale extends StockMovement {
     orderLine: OrderLine;
 }
 ```
-* Extends: <DocsLink href="/reference/typescript-api/entities/stock-movement#stockmovement">`StockMovement`</DocsLink>
+* Extends: [`StockMovement`](/reference/typescript-api/entities/stock-movement#stockmovement)
 
 
 
@@ -224,7 +224,7 @@ class StockAdjustment extends StockMovement {
     constructor(input: DeepPartial<StockAdjustment>)
 }
 ```
-* Extends: <DocsLink href="/reference/typescript-api/entities/stock-movement#stockmovement">`StockMovement`</DocsLink>
+* Extends: [`StockMovement`](/reference/typescript-api/entities/stock-movement#stockmovement)
 
 
 

package/docs/reference/typescript-api/entities/surcharge.mdx

@@ -4,7 +4,7 @@ generated: true
 ---
 <GenerationInfo sourceFile="packages/core/src/entity/surcharge/surcharge.entity.ts" sourceLine="21" packageName="@vendure/core" />
 
-A Surcharge represents an arbitrary extra item on an <DocsLink href="/reference/typescript-api/entities/order#order">Order</DocsLink> which is not
+A Surcharge represents an arbitrary extra item on an [Order](/reference/typescript-api/entities/order#order) which is not
 a ProductVariant. It can be used to e.g. represent payment-related surcharges.
 
 ```ts title="Signature"
@@ -31,7 +31,7 @@ class Surcharge extends VendureEntity {
     taxRate: number
 }
 ```
-* Extends: <DocsLink href="/reference/typescript-api/entities/vendure-entity#vendureentity">`VendureEntity`</DocsLink>
+* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
 
 
 

package/docs/reference/typescript-api/entities/tag.mdx

@@ -14,7 +14,7 @@ class Tag extends VendureEntity {
     value: string;
 }
 ```
-* Extends: <DocsLink href="/reference/typescript-api/entities/vendure-entity#vendureentity">`VendureEntity`</DocsLink>
+* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
 
 
 

package/docs/reference/typescript-api/entities/tax-category.mdx

@@ -4,7 +4,7 @@ generated: true
 ---
 <GenerationInfo sourceFile="packages/core/src/entity/tax-category/tax-category.entity.ts" sourceLine="16" packageName="@vendure/core" />
 
-A TaxCategory defines what type of taxes to apply to a <DocsLink href="/reference/typescript-api/entities/product-variant#productvariant">ProductVariant</DocsLink>.
+A TaxCategory defines what type of taxes to apply to a [ProductVariant](/reference/typescript-api/entities/product-variant#productvariant).
 
 ```ts title="Signature"
 class TaxCategory extends VendureEntity implements HasCustomFields {
@@ -19,7 +19,7 @@ class TaxCategory extends VendureEntity implements HasCustomFields {
     taxRates: TaxRate[];
 }
 ```
-* Extends: <DocsLink href="/reference/typescript-api/entities/vendure-entity#vendureentity">`VendureEntity`</DocsLink>
+* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
 
 
 * Implements: HasCustomFields

package/docs/reference/typescript-api/entities/tax-rate.mdx

@@ -4,11 +4,11 @@ generated: true
 ---
 <GenerationInfo sourceFile="packages/core/src/entity/tax-rate/tax-rate.entity.ts" sourceLine="26" packageName="@vendure/core" />
 
-A TaxRate defines the rate of tax to apply to a <DocsLink href="/reference/typescript-api/entities/product-variant#productvariant">ProductVariant</DocsLink> based on three factors:
+A TaxRate defines the rate of tax to apply to a [ProductVariant](/reference/typescript-api/entities/product-variant#productvariant) based on three factors:
 
-1. the ProductVariant's <DocsLink href="/reference/typescript-api/entities/tax-category#taxcategory">TaxCategory</DocsLink>
-2. the applicable <DocsLink href="/reference/typescript-api/entities/zone#zone">Zone</DocsLink> ("applicable" being defined by the configured <DocsLink href="/reference/typescript-api/tax/tax-zone-strategy#taxzonestrategy">TaxZoneStrategy</DocsLink>)
-3. the <DocsLink href="/reference/typescript-api/entities/customer-group#customergroup">CustomerGroup</DocsLink> of the current Customer
+1. the ProductVariant's [TaxCategory](/reference/typescript-api/entities/tax-category#taxcategory)
+2. the applicable [Zone](/reference/typescript-api/entities/zone#zone) ("applicable" being defined by the configured [TaxZoneStrategy](/reference/typescript-api/tax/tax-zone-strategy#taxzonestrategy))
+3. the [CustomerGroup](/reference/typescript-api/entities/customer-group#customergroup) of the current Customer
 
 ```ts title="Signature"
 class TaxRate extends VendureEntity implements HasCustomFields {
@@ -39,7 +39,7 @@ class TaxRate extends VendureEntity implements HasCustomFields {
     test(zone: Zone | ID, taxCategory: TaxCategory | ID) => boolean;
 }
 ```
-* Extends: <DocsLink href="/reference/typescript-api/entities/vendure-entity#vendureentity">`VendureEntity`</DocsLink>
+* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
 
 
 * Implements: HasCustomFields

package/docs/reference/typescript-api/entities/user.mdx

@@ -5,7 +5,7 @@ generated: true
 <GenerationInfo sourceFile="packages/core/src/entity/user/user.entity.ts" sourceLine="21" packageName="@vendure/core" />
 
 A User represents any authenticated user of the Vendure API. This includes both
-<DocsLink href="/reference/typescript-api/entities/administrator#administrator">Administrator</DocsLink>s as well as registered <DocsLink href="/reference/typescript-api/entities/customer#customer">Customer</DocsLink>s.
+[Administrator](/reference/typescript-api/entities/administrator#administrator)s as well as registered [Customer](/reference/typescript-api/entities/customer#customer)s.
 
 ```ts title="Signature"
 class User extends VendureEntity implements HasCustomFields, SoftDeletable {
@@ -32,10 +32,10 @@ class User extends VendureEntity implements HasCustomFields, SoftDeletable {
     getNativeAuthenticationMethod(strict?: boolean) => NativeAuthenticationMethod | undefined;
 }
 ```
-* Extends: <DocsLink href="/reference/typescript-api/entities/vendure-entity#vendureentity">`VendureEntity`</DocsLink>
+* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
 
 
-* Implements: HasCustomFields, <DocsLink href="/reference/typescript-api/entities/interfaces#softdeletable">`SoftDeletable`</DocsLink>
+* Implements: HasCustomFields, [`SoftDeletable`](/reference/typescript-api/entities/interfaces#softdeletable)
 
 
 

package/docs/reference/typescript-api/entities/vendure-entity.mdx

@@ -5,7 +5,7 @@ generated: true
 <GenerationInfo sourceFile="packages/core/src/entity/base/base.entity.ts" sourceLine="13" packageName="@vendure/core" />
 
 This is the base class from which all entities inherit. The type of
-the `id` property is defined by the <DocsLink href="/reference/typescript-api/configuration/entity-id-strategy#entityidstrategy">EntityIdStrategy</DocsLink>.
+the `id` property is defined by the [EntityIdStrategy](/reference/typescript-api/configuration/entity-id-strategy#entityidstrategy).
 
 ```ts title="Signature"
 class VendureEntity {

package/docs/reference/typescript-api/entities/zone.mdx

@@ -4,7 +4,7 @@ generated: true
 ---
 <GenerationInfo sourceFile="packages/core/src/entity/zone/zone.entity.ts" sourceLine="19" packageName="@vendure/core" />
 
-A Zone is a grouping of one or more <DocsLink href="/reference/typescript-api/entities/country#country">Country</DocsLink> entities. It is used for
+A Zone is a grouping of one or more [Country](/reference/typescript-api/entities/country#country) entities. It is used for
 calculating applicable shipping and taxes.
 
 ```ts title="Signature"
@@ -24,7 +24,7 @@ class Zone extends VendureEntity implements HasCustomFields {
     taxRates: TaxRate[];
 }
 ```
-* Extends: <DocsLink href="/reference/typescript-api/entities/vendure-entity#vendureentity">`VendureEntity`</DocsLink>
+* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
 
 
 * Implements: HasCustomFields

package/docs/reference/typescript-api/errors/error-handler-strategy.mdx

@@ -60,7 +60,7 @@ interface ErrorHandlerStrategy extends InjectableStrategy {
     handleWorkerError(exception: Error, context: { job: Job }): void | Promise<void>;
 }
 ```
-* Extends: <DocsLink href="/reference/typescript-api/common/injectable-strategy#injectablestrategy">`InjectableStrategy`</DocsLink>
+* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
 
 
 

package/docs/reference/typescript-api/errors/error-types.mdx

@@ -11,7 +11,7 @@ class InternalServerError extends I18nError {
     constructor(message: string, variables: { [key: string]: string | number } = {})
 }
 ```
-* Extends: <DocsLink href="/reference/typescript-api/errors/i18n-error#i18nerror">`I18nError`</DocsLink>
+* Extends: [`I18nError`](/reference/typescript-api/errors/i18n-error#i18nerror)
 
 
 
@@ -34,7 +34,7 @@ class UserInputError extends I18nError {
     constructor(message: string, variables: { [key: string]: string | number } = {})
 }
 ```
-* Extends: <DocsLink href="/reference/typescript-api/errors/i18n-error#i18nerror">`I18nError`</DocsLink>
+* Extends: [`I18nError`](/reference/typescript-api/errors/i18n-error#i18nerror)
 
 
 
@@ -57,7 +57,7 @@ class IllegalOperationError extends I18nError {
     constructor(message: string, variables: { [key: string]: string | number } = {})
 }
 ```
-* Extends: <DocsLink href="/reference/typescript-api/errors/i18n-error#i18nerror">`I18nError`</DocsLink>
+* Extends: [`I18nError`](/reference/typescript-api/errors/i18n-error#i18nerror)
 
 
 
@@ -80,7 +80,7 @@ class UnauthorizedError extends I18nError {
     constructor()
 }
 ```
-* Extends: <DocsLink href="/reference/typescript-api/errors/i18n-error#i18nerror">`I18nError`</DocsLink>
+* Extends: [`I18nError`](/reference/typescript-api/errors/i18n-error#i18nerror)
 
 
 
@@ -104,7 +104,7 @@ class ForbiddenError extends I18nError {
     constructor(logLevel: LogLevel = LogLevel.Warn)
 }
 ```
-* Extends: <DocsLink href="/reference/typescript-api/errors/i18n-error#i18nerror">`I18nError`</DocsLink>
+* Extends: [`I18nError`](/reference/typescript-api/errors/i18n-error#i18nerror)
 
 
 
@@ -120,7 +120,7 @@ class ForbiddenError extends I18nError {
 </div>
 <GenerationInfo sourceFile="packages/core/src/common/error/errors.ts" sourceLine="81" packageName="@vendure/core" />
 
-This error should be thrown when a <DocsLink href="/reference/typescript-api/entities/channel#channel">Channel</DocsLink> cannot be found based on the provided
+This error should be thrown when a [Channel](/reference/typescript-api/entities/channel#channel) cannot be found based on the provided
 channel token.
 
 ```ts title="Signature"
@@ -128,7 +128,7 @@ class ChannelNotFoundError extends I18nError {
     constructor(token: string)
 }
 ```
-* Extends: <DocsLink href="/reference/typescript-api/errors/i18n-error#i18nerror">`I18nError`</DocsLink>
+* Extends: [`I18nError`](/reference/typescript-api/errors/i18n-error#i18nerror)
 
 
 
@@ -152,7 +152,7 @@ class EntityNotFoundError extends I18nError {
     constructor(entityName: keyof typeof coreEntitiesMap | string, id: ID)
 }
 ```
-* Extends: <DocsLink href="/reference/typescript-api/errors/i18n-error#i18nerror">`I18nError`</DocsLink>
+* Extends: [`I18nError`](/reference/typescript-api/errors/i18n-error#i18nerror)
 
 
 

package/docs/reference/typescript-api/errors/is-graph-ql-error-result.mdx

@@ -4,7 +4,7 @@ generated: true
 ---
 <GenerationInfo sourceFile="packages/core/src/common/error/error-result.ts" sourceLine="71" packageName="@vendure/core" />
 
-Returns true if the <DocsLink href="/reference/typescript-api/errors/error-result-union#errorresultunion">ErrorResultUnion</DocsLink> is actually an ErrorResult type. This is useful when dealing with
+Returns true if the [ErrorResultUnion](/reference/typescript-api/errors/error-result-union#errorresultunion) is actually an ErrorResult type. This is useful when dealing with
 certain internal service method that return an ErrorResultUnion.
 
 *Example*

package/docs/reference/typescript-api/events/event-bus.mdx

@@ -8,9 +8,9 @@ The EventBus is used to globally publish events which can then be subscribed to.
 
 Events are published whenever certain actions take place within the Vendure server, for example:
 
-* when a Product is updated (<DocsLink href="/reference/typescript-api/events/event-types#productevent">ProductEvent</DocsLink>)
-* when an Order transitions state (<DocsLink href="/reference/typescript-api/events/event-types#orderstatetransitionevent">OrderStateTransitionEvent</DocsLink>)
-* when a Customer registers a new account (<DocsLink href="/reference/typescript-api/events/event-types#accountregistrationevent">AccountRegistrationEvent</DocsLink>)
+* when a Product is updated ([ProductEvent](/reference/typescript-api/events/event-types#productevent))
+* when an Order transitions state ([OrderStateTransitionEvent](/reference/typescript-api/events/event-types#orderstatetransitionevent))
+* when a Customer registers a new account ([AccountRegistrationEvent](/reference/typescript-api/events/event-types#accountregistrationevent))
 
 Using the EventBus it is possible to subscribe to an take action when these events occur.
 This is done with the `.ofType()` method, which takes an event type and returns an rxjs observable
@@ -80,7 +80,7 @@ await eventBus.publish(new SomeEvent());
 <MemberInfo kind="method" type={`(type: Type<T>) => Observable<T>`}   />
 
 Returns an RxJS Observable stream of events of the given type.
-If the event contains a <DocsLink href="/reference/typescript-api/request/request-context#requestcontext">RequestContext</DocsLink> object, the subscriber
+If the event contains a [RequestContext](/reference/typescript-api/request/request-context#requestcontext) object, the subscriber
 will only get called after any active database transactions are complete.
 
 This means that the subscriber function can safely access all updated
@@ -90,7 +90,7 @@ data related to the event.
 <MemberInfo kind="method" type={`(predicate: (event: <a href='/reference/typescript-api/events/vendure-event#vendureevent'>VendureEvent</a>) => boolean) => Observable<T>`}   />
 
 Returns an RxJS Observable stream of events filtered by a custom predicate.
-If the event contains a <DocsLink href="/reference/typescript-api/request/request-context#requestcontext">RequestContext</DocsLink> object, the subscriber
+If the event contains a [RequestContext](/reference/typescript-api/request/request-context#requestcontext) object, the subscriber
 will only get called after any active database transactions are complete.
 
 This means that the subscriber function can safely access all updated
@@ -109,7 +109,7 @@ the triggering code to fail if the handler fails.
 This API should be used with caution, as errors or performance issues in the handler can cause the
 associated operation to be slow or fail entirely. For this reason, any handler which takes longer than
 100ms to execute will log a warning. Any non-trivial task to be performed in a blocking event handler
-should be offloaded to a background job using the <DocsLink href="/reference/typescript-api/job-queue/job-queue-service#jobqueueservice">JobQueueService</DocsLink>.
+should be offloaded to a background job using the [JobQueueService](/reference/typescript-api/job-queue/job-queue-service#jobqueueservice).
 
 Also, be aware that the handler will be executed in the _same database transaction_ as the code which published
 the event (as long as you pass the `ctx` object from the event to any TransactionalConnection calls).