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

@vendure/docs 0.0.0-202601210957 → 0.0.0-202601211028

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 (582) hide show

package/docs/reference/typescript-api/entities/region.mdx CHANGED Viewed

@@ -2,15 +2,11 @@
 title: "Region"
 generated: true
 ---
-## Region
 <GenerationInfo sourceFile="packages/core/src/entity/region/region.entity.ts" sourceLine="22" packageName="@vendure/core" />
 A Region represents a geographical administrative unit, such as a Country, Province, State, Prefecture etc.
-This is an abstract class which is extended by the <a href='/reference/typescript-api/entities/country#country'>Country</a> and <a href='/reference/typescript-api/entities/province#province'>Province</a> entities.
-Regions can be grouped into <a href='/reference/typescript-api/entities/zone#zone'>Zone</a>s which are in turn used to determine applicable shipping and taxes for an <a href='/reference/typescript-api/entities/order#order'>Order</a>.
+This is an abstract class which is extended by the <DocsLink href="/reference/typescript-api/entities/country#country">Country</DocsLink> and <DocsLink href="/reference/typescript-api/entities/province#province">Province</DocsLink> entities.
+Regions can be grouped into <DocsLink href="/reference/typescript-api/entities/zone#zone">Zone</DocsLink>s which are in turn used to determine applicable shipping and taxes for an <DocsLink href="/reference/typescript-api/entities/order#order">Order</DocsLink>.
 ```ts title="Signature"
 class Region extends VendureEntity implements Translatable, HasCustomFields {

package/docs/reference/typescript-api/entities/role.mdx CHANGED Viewed

@@ -2,14 +2,10 @@
 title: "Role"
 generated: true
 ---
-## Role
 <GenerationInfo sourceFile="packages/core/src/entity/role/role.entity.ts" sourceLine="16" packageName="@vendure/core" />
 A Role represents a collection of permissions which determine the authorization
-level of a <a href='/reference/typescript-api/entities/user#user'>User</a> on a given set of <a href='/reference/typescript-api/entities/channel#channel'>Channel</a>s.
+level of a <DocsLink href="/reference/typescript-api/entities/user#user">User</DocsLink> on a given set of <DocsLink href="/reference/typescript-api/entities/channel#channel">Channel</DocsLink>s.
 ```ts title="Signature"
 class Role extends VendureEntity implements ChannelAware {

package/docs/reference/typescript-api/entities/seller.mdx CHANGED Viewed

@@ -2,13 +2,9 @@
 title: "Seller"
 generated: true
 ---
-## Seller
 <GenerationInfo sourceFile="packages/core/src/entity/seller/seller.entity.ts" sourceLine="17" packageName="@vendure/core" />
-A Seller represents the person or organization who is selling the goods on a given <a href='/reference/typescript-api/entities/channel#channel'>Channel</a>.
+A Seller represents the person or organization who is selling the goods on a given <DocsLink href="/reference/typescript-api/entities/channel#channel">Channel</DocsLink>.
 By default, a single-channel Vendure installation will have a single default Seller.
 ```ts title="Signature"

package/docs/reference/typescript-api/entities/session.mdx CHANGED Viewed

@@ -2,14 +2,10 @@
 title: "Session"
 generated: true
 ---
-## Session
 <GenerationInfo sourceFile="packages/core/src/entity/session/session.entity.ts" sourceLine="18" packageName="@vendure/core" />
-A Session is created when a user makes a request to restricted API operations. A Session can be an <a href='/reference/typescript-api/entities/anonymous-session#anonymoussession'>AnonymousSession</a>
-in the case of un-authenticated users, otherwise it is an <a href='/reference/typescript-api/entities/authenticated-session#authenticatedsession'>AuthenticatedSession</a>.
+A Session is created when a user makes a request to restricted API operations. A Session can be an <DocsLink href="/reference/typescript-api/entities/anonymous-session#anonymoussession">AnonymousSession</DocsLink>
+in the case of un-authenticated users, otherwise it is an <DocsLink href="/reference/typescript-api/entities/authenticated-session#authenticatedsession">AuthenticatedSession</DocsLink>.
 ```ts title="Signature"
 class Session extends VendureEntity implements HasCustomFields {

package/docs/reference/typescript-api/entities/settings-store-entry.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "SettingsStoreEntry"
 generated: true
 ---
-## SettingsStoreEntry
 <GenerationInfo sourceFile="packages/core/src/entity/settings-store-entry/settings-store-entry.entity.ts" sourceLine="15" packageName="@vendure/core" since="3.4.0" />
 An entity for storing arbitrary settings data with scoped isolation.

package/docs/reference/typescript-api/entities/shipping-line.mdx CHANGED Viewed

@@ -2,13 +2,9 @@
 title: "ShippingLine"
 generated: true
 ---
-## ShippingLine
 <GenerationInfo sourceFile="packages/core/src/entity/shipping-line/shipping-line.entity.ts" sourceLine="26" packageName="@vendure/core" />
-A ShippingLine is created when a <a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a> is applied to an <a href='/reference/typescript-api/entities/order#order'>Order</a>.
+A ShippingLine is created when a <DocsLink href="/reference/typescript-api/entities/shipping-method#shippingmethod">ShippingMethod</DocsLink> is applied to an <DocsLink href="/reference/typescript-api/entities/order#order">Order</DocsLink>.
 It contains information about the price of the shipping method, any discounts that were
 applied, and the resulting tax on the shipping method.

package/docs/reference/typescript-api/entities/shipping-method.mdx CHANGED Viewed

@@ -2,14 +2,10 @@
 title: "ShippingMethod"
 generated: true
 ---
-## ShippingMethod
 <GenerationInfo sourceFile="packages/core/src/entity/shipping-method/shipping-method.entity.ts" sourceLine="34" packageName="@vendure/core" />
-A ShippingMethod is used to apply a shipping price to an <a href='/reference/typescript-api/entities/order#order'>Order</a>. It is composed of a
-<a href='/reference/typescript-api/shipping/shipping-eligibility-checker#shippingeligibilitychecker'>ShippingEligibilityChecker</a> and a <a href='/reference/typescript-api/shipping/shipping-calculator#shippingcalculator'>ShippingCalculator</a>. For a given Order,
+A ShippingMethod is used to apply a shipping price to an <DocsLink href="/reference/typescript-api/entities/order#order">Order</DocsLink>. It is composed of a
+<DocsLink href="/reference/typescript-api/shipping/shipping-eligibility-checker#shippingeligibilitychecker">ShippingEligibilityChecker</DocsLink> and a <DocsLink href="/reference/typescript-api/shipping/shipping-calculator#shippingcalculator">ShippingCalculator</DocsLink>. For a given Order,
 the `checker` is used to determine whether this ShippingMethod can be used. If yes, then
 the ShippingMethod can be applied and the `calculator` is used to determine the price of
 shipping.

package/docs/reference/typescript-api/entities/stock-level.mdx CHANGED Viewed

@@ -2,14 +2,10 @@
 title: "StockLevel"
 generated: true
 ---
-## StockLevel
 <GenerationInfo sourceFile="packages/core/src/entity/stock-level/stock-level.entity.ts" sourceLine="18" packageName="@vendure/core" />
-A StockLevel represents the number of a particular <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a> which are available
-at a particular <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>.
+A StockLevel represents the number of a particular <DocsLink href="/reference/typescript-api/entities/product-variant#productvariant">ProductVariant</DocsLink> which are available
+at a particular <DocsLink href="/reference/typescript-api/entities/stock-location#stocklocation">StockLocation</DocsLink>.
 ```ts title="Signature"
 class StockLevel extends VendureEntity implements HasCustomFields {

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

@@ -2,17 +2,13 @@
 title: "StockLocation"
 generated: true
 ---
-## StockLocation
 <GenerationInfo sourceFile="packages/core/src/entity/stock-location/stock-location.entity.ts" sourceLine="22" packageName="@vendure/core" />
 A StockLocation represents a physical location where stock is held. For example, a warehouse or a shop.
-When the stock of a <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a> is adjusted, the adjustment is applied to a specific StockLocation,
+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,
 and the stockOnHand of that ProductVariant is updated accordingly. When there are multiple StockLocations
-configured, the <a href='/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy'>StockLocationStrategy</a> is used to determine which StockLocation should be used for
+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
 a given operation.
 ```ts title="Signature"

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

@@ -2,10 +2,6 @@
 title: "StockMovement"
 generated: true
 ---
-## StockMovement
 <GenerationInfo sourceFile="packages/core/src/entity/stock-movement/stock-movement.entity.ts" sourceLine="21" packageName="@vendure/core" />
 A StockMovement is created whenever stock of a particular ProductVariant goes in
@@ -71,14 +67,10 @@ class StockMovement extends VendureEntity implements HasCustomFields {
 </div>
-## Allocation
 <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 <a href='/reference/typescript-api/orders/stock-allocation-strategy#stockallocationstrategy'>StockAllocationStrategy</a>. This prevents stock being sold twice.
+(as configured by the <DocsLink href="/reference/typescript-api/orders/stock-allocation-strategy#stockallocationstrategy">StockAllocationStrategy</DocsLink>. This prevents stock being sold twice.
 ```ts title="Signature"
 class Allocation extends StockMovement {
@@ -113,10 +105,6 @@ class Allocation extends StockMovement {
 </div>
-## Cancellation
 <GenerationInfo sourceFile="packages/core/src/entity/stock-movement/cancellation.entity.ts" sourceLine="16" packageName="@vendure/core" />
 A Cancellation is created when OrderItems from a fulfilled Order are cancelled.
@@ -153,10 +141,6 @@ class Cancellation extends StockMovement {
 </div>
-## Release
 <GenerationInfo sourceFile="packages/core/src/entity/stock-movement/release.entity.ts" sourceLine="17" packageName="@vendure/core" />
 A Release is created when OrderItems which have been allocated (but not yet fulfilled)
@@ -194,10 +178,6 @@ class Release extends StockMovement {
 </div>
-## Sale
 <GenerationInfo sourceFile="packages/core/src/entity/stock-movement/sale.entity.ts" sourceLine="16" packageName="@vendure/core" />
 A Sale is created when OrderItems are fulfilled.
@@ -234,10 +214,6 @@ class Sale extends StockMovement {
 </div>
-## StockAdjustment
 <GenerationInfo sourceFile="packages/core/src/entity/stock-movement/stock-adjustment.entity.ts" sourceLine="14" packageName="@vendure/core" />
 A StockAdjustment is created when the `stockOnHand` level of a ProductVariant is manually adjusted.

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

@@ -2,13 +2,9 @@
 title: "Surcharge"
 generated: true
 ---
-## Surcharge
 <GenerationInfo sourceFile="packages/core/src/entity/surcharge/surcharge.entity.ts" sourceLine="21" packageName="@vendure/core" />
-A Surcharge represents an arbitrary extra item on an <a href='/reference/typescript-api/entities/order#order'>Order</a> which is not
+A Surcharge represents an arbitrary extra item on an <DocsLink href="/reference/typescript-api/entities/order#order">Order</DocsLink> which is not
 a ProductVariant. It can be used to e.g. represent payment-related surcharges.
 ```ts title="Signature"

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

@@ -2,10 +2,6 @@
 title: "Tag"
 generated: true
 ---
-## Tag
 <GenerationInfo sourceFile="packages/core/src/entity/tag/tag.entity.ts" sourceLine="13" packageName="@vendure/core" />
 A tag is an arbitrary label which can be applied to certain entities.

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

@@ -2,13 +2,9 @@
 title: "TaxCategory"
 generated: true
 ---
-## TaxCategory
 <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 <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>.
+A TaxCategory defines what type of taxes to apply to a <DocsLink href="/reference/typescript-api/entities/product-variant#productvariant">ProductVariant</DocsLink>.
 ```ts title="Signature"
 class TaxCategory extends VendureEntity implements HasCustomFields {

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

@@ -2,17 +2,13 @@
 title: "TaxRate"
 generated: true
 ---
-## TaxRate
 <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 <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a> based on three factors:
+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:
-1. the ProductVariant's <a href='/reference/typescript-api/entities/tax-category#taxcategory'>TaxCategory</a>
-2. the applicable <a href='/reference/typescript-api/entities/zone#zone'>Zone</a> ("applicable" being defined by the configured <a href='/reference/typescript-api/tax/tax-zone-strategy#taxzonestrategy'>TaxZoneStrategy</a>)
-3. the <a href='/reference/typescript-api/entities/customer-group#customergroup'>CustomerGroup</a> of the current Customer
+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
 ```ts title="Signature"
 class TaxRate extends VendureEntity implements HasCustomFields {

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

@@ -2,14 +2,10 @@
 title: "User"
 generated: true
 ---
-## User
 <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
-<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>s as well as registered <a href='/reference/typescript-api/entities/customer#customer'>Customer</a>s.
+<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.
 ```ts title="Signature"
 class User extends VendureEntity implements HasCustomFields, SoftDeletable {

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

@@ -2,14 +2,10 @@
 title: "VendureEntity"
 generated: true
 ---
-## VendureEntity
 <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 <a href='/reference/typescript-api/configuration/entity-id-strategy#entityidstrategy'>EntityIdStrategy</a>.
+the `id` property is defined by the <DocsLink href="/reference/typescript-api/configuration/entity-id-strategy#entityidstrategy">EntityIdStrategy</DocsLink>.
 ```ts title="Signature"
 class VendureEntity {

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

@@ -2,13 +2,9 @@
 title: "Zone"
 generated: true
 ---
-## Zone
 <GenerationInfo sourceFile="packages/core/src/entity/zone/zone.entity.ts" sourceLine="19" packageName="@vendure/core" />
-A Zone is a grouping of one or more <a href='/reference/typescript-api/entities/country#country'>Country</a> entities. It is used for
+A Zone is a grouping of one or more <DocsLink href="/reference/typescript-api/entities/country#country">Country</DocsLink> entities. It is used for
 calculating applicable shipping and taxes.
 ```ts title="Signature"

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

@@ -2,10 +2,6 @@
 title: "ErrorHandlerStrategy"
 generated: true
 ---
-## ErrorHandlerStrategy
 <GenerationInfo sourceFile="packages/core/src/config/system/error-handler-strategy.ts" sourceLine="60" packageName="@vendure/core" since="2.2.0" />
 This strategy defines logic for handling errors thrown during on both the server

package/docs/reference/typescript-api/errors/error-result-union.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "ErrorResultUnion"
 generated: true
 ---
-## ErrorResultUnion
 <GenerationInfo sourceFile="packages/core/src/common/error/error-result.ts" sourceLine="44" packageName="@vendure/core" />
 Used to construct a TypeScript return type for a query or mutation which, in the GraphQL schema,

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

@@ -2,10 +2,6 @@
 title: "Error Types"
 generated: true
 ---
-## InternalServerError
 <GenerationInfo sourceFile="packages/core/src/common/error/errors.ts" sourceLine="14" packageName="@vendure/core" />
 This error should be thrown when some unexpected and exceptional case is encountered.
@@ -29,10 +25,6 @@ class InternalServerError extends I18nError {
 </div>
-## UserInputError
 <GenerationInfo sourceFile="packages/core/src/common/error/errors.ts" sourceLine="27" packageName="@vendure/core" />
 This error should be thrown when user input is not as expected.
@@ -56,10 +48,6 @@ class UserInputError extends I18nError {
 </div>
-## IllegalOperationError
 <GenerationInfo sourceFile="packages/core/src/common/error/errors.ts" sourceLine="40" packageName="@vendure/core" />
 This error should be thrown when an operation is attempted which is not allowed.
@@ -83,10 +71,6 @@ class IllegalOperationError extends I18nError {
 </div>
-## UnauthorizedError
 <GenerationInfo sourceFile="packages/core/src/common/error/errors.ts" sourceLine="53" packageName="@vendure/core" />
 This error should be thrown when the user's authentication credentials do not match.
@@ -110,10 +94,6 @@ class UnauthorizedError extends I18nError {
 </div>
-## ForbiddenError
 <GenerationInfo sourceFile="packages/core/src/common/error/errors.ts" sourceLine="67" packageName="@vendure/core" />
 This error should be thrown when a user attempts to access a resource which is outside of
@@ -138,13 +118,9 @@ class ForbiddenError extends I18nError {
 </div>
-## ChannelNotFoundError
 <GenerationInfo sourceFile="packages/core/src/common/error/errors.ts" sourceLine="81" packageName="@vendure/core" />
-This error should be thrown when a <a href='/reference/typescript-api/entities/channel#channel'>Channel</a> cannot be found based on the provided
+This error should be thrown when a <DocsLink href="/reference/typescript-api/entities/channel#channel">Channel</DocsLink> cannot be found based on the provided
 channel token.
 ```ts title="Signature"
@@ -166,10 +142,6 @@ class ChannelNotFoundError extends I18nError {
 </div>
-## EntityNotFoundError
 <GenerationInfo sourceFile="packages/core/src/common/error/errors.ts" sourceLine="95" packageName="@vendure/core" />
 This error should be thrown when an entity cannot be found in the database, i.e. no entity of

package/docs/reference/typescript-api/errors/i18n-error.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "I18nError"
 generated: true
 ---
-## I18nError
 <GenerationInfo sourceFile="packages/core/src/i18n/i18n-error.ts" sourceLine="18" packageName="@vendure/core" />
 All errors thrown in the Vendure server must use or extend this error class. This allows the

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

@@ -2,13 +2,9 @@
 title: "IsGraphQlErrorResult"
 generated: true
 ---
-## isGraphQlErrorResult
 <GenerationInfo sourceFile="packages/core/src/common/error/error-result.ts" sourceLine="71" packageName="@vendure/core" />
-Returns true if the <a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a> is actually an ErrorResult type. This is useful when dealing with
+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
 certain internal service method that return an ErrorResultUnion.
 *Example*

package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx CHANGED Viewed

@@ -2,10 +2,6 @@
 title: "BlockingEventHandlerOptions"
 generated: true
 ---
-## BlockingEventHandlerOptions
 <GenerationInfo sourceFile="packages/core/src/event-bus/event-bus.ts" sourceLine="23" packageName="@vendure/core" since="2.2.0" />
 Options for registering a blocking event handler.

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

@@ -2,19 +2,15 @@
 title: "EventBus"
 generated: true
 ---
-## EventBus
 <GenerationInfo sourceFile="packages/core/src/event-bus/event-bus.ts" sourceLine="98" packageName="@vendure/core" />
 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 (<a href='/reference/typescript-api/events/event-types#productevent'>ProductEvent</a>)
-* when an Order transitions state (<a href='/reference/typescript-api/events/event-types#orderstatetransitionevent'>OrderStateTransitionEvent</a>)
-* when a Customer registers a new account (<a href='/reference/typescript-api/events/event-types#accountregistrationevent'>AccountRegistrationEvent</a>)
+* 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>)
 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
@@ -84,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 <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> object, the subscriber
+If the event contains a <DocsLink href="/reference/typescript-api/request/request-context#requestcontext">RequestContext</DocsLink> 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
@@ -94,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 <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> object, the subscriber
+If the event contains a <DocsLink href="/reference/typescript-api/request/request-context#requestcontext">RequestContext</DocsLink> 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
@@ -113,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 <a href='/reference/typescript-api/job-queue/job-queue-service#jobqueueservice'>JobQueueService</a>.
+should be offloaded to a background job using the <DocsLink href="/reference/typescript-api/job-queue/job-queue-service#jobqueueservice">JobQueueService</DocsLink>.
 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).