@vendure/docs 0.0.0-202601210957 → 0.0.0-202601211038

package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx

@@ -2,14 +2,10 @@
 title: "RuntimeVendureConfig"
 generated: true
 ---
-
-
-## RuntimeVendureConfig
-
 <GenerationInfo sourceFile="packages/core/src/config/vendure-config.ts" sourceLine="1319" packageName="@vendure/core" />
 
 This interface represents the VendureConfig object available at run-time, i.e. the user-supplied
-config values have been merged with the <a href='/reference/typescript-api/configuration/default-config#defaultconfig'>defaultConfig</a> values.
+config values have been merged with the <DocsLink href="/reference/typescript-api/configuration/default-config#defaultconfig">defaultConfig</DocsLink> values.
 
 ```ts title="Signature"
 interface RuntimeVendureConfig extends Required<VendureConfig> {

package/docs/reference/typescript-api/configuration/settings-store-fields.mdx

@@ -2,13 +2,9 @@
 title: "SettingsStoreFields"
 generated: true
 ---
-
-
-## SettingsStoreFields
-
 <GenerationInfo sourceFile="packages/core/src/config/settings-store/settings-store-types.ts" sourceLine="141" packageName="@vendure/core" since="3.4.0" />
 
-This is how SettingsStoreFields are defined in the <a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a> object.
+This is how SettingsStoreFields are defined in the <DocsLink href="/reference/typescript-api/configuration/vendure-config#vendureconfig">VendureConfig</DocsLink> object.
 
 ```ts title="Signature"
 type SettingsStoreFields = {

package/docs/reference/typescript-api/configuration/slug-strategy.mdx

@@ -2,10 +2,6 @@
 title: "SlugStrategy"
 generated: true
 ---
-
-
-## SlugStrategy
-
 <GenerationInfo sourceFile="packages/core/src/config/entity/slug-strategy.ts" sourceLine="44" packageName="@vendure/core" since="3.5.0" />
 
 Defines the strategy for generating slugs from input strings.

package/docs/reference/typescript-api/configuration/system-options.mdx

@@ -2,10 +2,6 @@
 title: "SystemOptions"
 generated: true
 ---
-
-
-## SystemOptions
-
 <GenerationInfo sourceFile="packages/core/src/config/vendure-config.ts" sourceLine="1134" packageName="@vendure/core" since="1.6.0" />
 
 Options relating to system functions.
@@ -25,20 +21,20 @@ interface SystemOptions {
 
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy'>HealthCheckStrategy</a>[]`} default={`[<a href='/reference/typescript-api/health-check/type-ormhealth-check-strategy#typeormhealthcheckstrategy'>TypeORMHealthCheckStrategy</a>]`}  since="1.6.0"  />
 
-Defines an array of <a href='/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy'>HealthCheckStrategy</a> instances which are used by the `/health` endpoint to verify
+Defines an array of <DocsLink href="/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy">HealthCheckStrategy</DocsLink> instances which are used by the `/health` endpoint to verify
 that any critical systems which the Vendure server depends on are also healthy.
 ### errorHandlers
 
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/errors/error-handler-strategy#errorhandlerstrategy'>ErrorHandlerStrategy</a>[]`} default={`[]`}  since="2.2.0"  />
 
-Defines an array of <a href='/reference/typescript-api/errors/error-handler-strategy#errorhandlerstrategy'>ErrorHandlerStrategy</a> instances which are used to define logic to be executed
+Defines an array of <DocsLink href="/reference/typescript-api/errors/error-handler-strategy#errorhandlerstrategy">ErrorHandlerStrategy</DocsLink> instances which are used to define logic to be executed
 when an error occurs, either on the server or the worker.
 ### cacheStrategy
 
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/cache/cache-strategy#cachestrategy'>CacheStrategy</a>`} default={`InMemoryCacheStrategy`}  since="3.1.0"  />
 
 Defines the underlying method used to store cache key-value pairs which powers the
-<a href='/reference/typescript-api/cache/cache-service#cacheservice'>CacheService</a>.
+<DocsLink href="/reference/typescript-api/cache/cache-service#cacheservice">CacheService</DocsLink>.
 ### instrumentationStrategy
 
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/telemetry/instrumentation-strategy#instrumentationstrategy'>InstrumentationStrategy</a>`}   />

package/docs/reference/typescript-api/configuration/trust-proxy-options.mdx

@@ -2,10 +2,6 @@
 title: "TrustProxyOptions"
 generated: true
 ---
-
-
-## TrustProxyOptions
-
 <GenerationInfo sourceFile="packages/core/src/config/vendure-config.ts" sourceLine="245" packageName="@vendure/core" since="3.4.0" />
 
 Configures Express trust proxy settings when running behind a reverse proxy (usually the case with most hosting services).

package/docs/reference/typescript-api/configuration/vendure-config.mdx

@@ -2,10 +2,6 @@
 title: "VendureConfig"
 generated: true
 ---
-
-
-## VendureConfig
-
 <GenerationInfo sourceFile="packages/core/src/config/vendure-config.ts" sourceLine="1172" packageName="@vendure/core" />
 
 All possible configuration options are defined by the
@@ -71,7 +67,7 @@ Defines custom fields which can be used to extend the built-in entities.
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/configuration/settings-store-fields#settingsstorefields'>SettingsStoreFields</a>`}  since="3.4.0"  />
 
 Defines key-value fields that can be set and read via the `getKeyValue`/`setKeyValue` GraphQL APIs
-and via the <a href='/reference/typescript-api/services/settings-store-service#settingsstoreservice'>SettingsStoreService</a>. These differ from custom fields in that they are not associated
+and via the <DocsLink href="/reference/typescript-api/services/settings-store-service#settingsstoreservice">SettingsStoreService</DocsLink>. These differ from custom fields in that they are not associated
 with a specific entity, but can be scoped globally or to a specific user etc, and defining them does not
 require any changes to the database schema.
 ### dbConnectionOptions
@@ -139,7 +135,7 @@ Configures the available checkers and calculators for ShippingMethods.
 
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/logger/vendure-logger#vendurelogger'>VendureLogger</a>`} default={`<a href='/reference/typescript-api/logger/default-logger#defaultlogger'>DefaultLogger</a>`}   />
 
-Provide a logging service which implements the <a href='/reference/typescript-api/logger/vendure-logger#vendurelogger'>VendureLogger</a> interface.
+Provide a logging service which implements the <DocsLink href="/reference/typescript-api/logger/vendure-logger#vendurelogger">VendureLogger</DocsLink> interface.
 Note that the logging of SQL queries is controlled separately by the
 `dbConnectionOptions.logging` property.
 ### taxOptions

package/docs/reference/typescript-api/custom-fields/custom-field-config.mdx

@@ -2,10 +2,6 @@
 title: "CustomFieldConfig"
 generated: true
 ---
-
-
-## CustomFieldConfig
-
 <GenerationInfo sourceFile="packages/core/src/config/custom-field/custom-field-types.ts" sourceLine="237" packageName="@vendure/core" />
 
 An object used to configure a custom field.

package/docs/reference/typescript-api/custom-fields/custom-field-type.mdx

@@ -2,10 +2,6 @@
 title: "CustomFieldType"
 generated: true
 ---
-
-
-## CustomFieldType
-
 <GenerationInfo sourceFile="packages/common/src/shared-types.ts" sourceLine="104" packageName="@vendure/common" />
 
 A data type for a custom field. The CustomFieldType determines the data types used in the generated

package/docs/reference/typescript-api/custom-fields/index.mdx

@@ -2,13 +2,9 @@
 title: "CustomFields"
 generated: true
 ---
-
-
-## CustomFields
-
 <GenerationInfo sourceFile="packages/core/src/config/custom-field/custom-field-types.ts" sourceLine="273" packageName="@vendure/core" />
 
-Most entities can have additional fields added to them by defining an array of <a href='/reference/typescript-api/custom-fields/custom-field-config#customfieldconfig'>CustomFieldConfig</a>objects on against the corresponding key.
+Most entities can have additional fields added to them by defining an array of <DocsLink href="/reference/typescript-api/custom-fields/custom-field-config#customfieldconfig">CustomFieldConfig</DocsLink>objects on against the corresponding key.
 
 *Example*
 

package/docs/reference/typescript-api/custom-fields/struct-custom-field-config.mdx

@@ -2,10 +2,6 @@
 title: "StructCustomFieldConfig"
 generated: true
 ---
-
-
-## StructCustomFieldConfig
-
 <GenerationInfo sourceFile="packages/core/src/config/custom-field/custom-field-types.ts" sourceLine="224" packageName="@vendure/core" since="3.1.0" />
 
 Configures a "struct" custom field.

package/docs/reference/typescript-api/custom-fields/struct-field-config.mdx

@@ -2,10 +2,6 @@
 title: "StructFieldConfig"
 generated: true
 ---
-
-
-## StructFieldConfig
-
 <GenerationInfo sourceFile="packages/core/src/config/custom-field/custom-field-types.ts" sourceLine="209" packageName="@vendure/core" since="3.1.0" />
 
 Configures an individual field of a "struct" custom field. The individual fields share

package/docs/reference/typescript-api/custom-fields/typed-custom-single-field-config.mdx

@@ -2,13 +2,9 @@
 title: "TypedCustomSingleFieldConfig"
 generated: true
 ---
-
-
-## TypedCustomSingleFieldConfig
-
 <GenerationInfo sourceFile="packages/core/src/config/custom-field/custom-field-types.ts" sourceLine="84" packageName="@vendure/core" />
 
-Configures a custom field on an entity in the <a href='/reference/typescript-api/custom-fields/#customfields'>CustomFields</a> config object.
+Configures a custom field on an entity in the <DocsLink href="/reference/typescript-api/custom-fields/#customfields">CustomFields</DocsLink> config object.
 
 ```ts title="Signature"
 type TypedCustomSingleFieldConfig<T extends CustomFieldType, C extends CustomField> = BaseTypedCustomFieldConfig<T, C> & {

package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx

@@ -2,10 +2,6 @@
 title: "CalculatedPropertySubscriber"
 generated: true
 ---
-
-
-## CalculatedPropertySubscriber
-
 <GenerationInfo sourceFile="packages/core/src/entity/subscribers.ts" sourceLine="14" packageName="@vendure/core" />
 
 

package/docs/reference/typescript-api/data-access/calculated.mdx

@@ -2,14 +2,10 @@
 title: "Calculated"
 generated: true
 ---
-
-
-## Calculated
-
 <GenerationInfo sourceFile="packages/core/src/common/calculated-decorator.ts" sourceLine="43" packageName="@vendure/core" />
 
 Used to define calculated entity getters. The decorator simply attaches an array of "calculated"
-property names to the entity's prototype. This array is then used by the <a href='/reference/typescript-api/data-access/calculated-property-subscriber#calculatedpropertysubscriber'>CalculatedPropertySubscriber</a>to transfer the getter function from the prototype to the entity instance.
+property names to the entity's prototype. This array is then used by the <DocsLink href="/reference/typescript-api/data-access/calculated-property-subscriber#calculatedpropertysubscriber">CalculatedPropertySubscriber</DocsLink>to transfer the getter function from the prototype to the entity instance.
 
 ```ts title="Signature"
 function Calculated(queryInstruction?: CalculatedColumnQueryInstruction): MethodDecorator
@@ -20,13 +16,9 @@ Parameters
 
 <MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/data-access/calculated#calculatedcolumnqueryinstruction'>CalculatedColumnQueryInstruction</a>`} />
 
-
-
-## CalculatedColumnQueryInstruction
-
 <GenerationInfo sourceFile="packages/core/src/common/calculated-decorator.ts" sourceLine="17" packageName="@vendure/core" />
 
-Optional metadata used to tell the <a href='/reference/typescript-api/data-access/list-query-builder#listquerybuilder'>ListQueryBuilder</a> & <a href='/reference/typescript-api/request/relations-decorator#relations'>Relations</a> decorator how to deal with
+Optional metadata used to tell the <DocsLink href="/reference/typescript-api/data-access/list-query-builder#listquerybuilder">ListQueryBuilder</DocsLink> & <DocsLink href="/reference/typescript-api/request/relations-decorator#relations">Relations</DocsLink> decorator how to deal with
 calculated columns when sorting, filtering and deriving required relations from GraphQL operations.
 
 ```ts title="Signature"

package/docs/reference/typescript-api/data-access/entity-hydrator.mdx

@@ -2,10 +2,6 @@
 title: "EntityHydrator"
 generated: true
 ---
-
-
-## EntityHydrator
-
 <GenerationInfo sourceFile="packages/core/src/service/helpers/entity-hydrator/entity-hydrator.service.ts" sourceLine="77" packageName="@vendure/core" since="1.3.0" />
 
 This is a helper class which is used to "hydrate" entity instances, which means to populate them
@@ -49,7 +45,7 @@ available, and those FacetValues will have their `facet` relations joined too.
 
 This `hydrate` method will _also_ automatically take care or translating any
 translatable entities (e.g. Product, Collection, Facet), and if the `applyProductVariantPrices`
-options is used (see <a href='/reference/typescript-api/data-access/hydrate-options#hydrateoptions'>HydrateOptions</a>), any related ProductVariant will have the correct
+options is used (see <DocsLink href="/reference/typescript-api/data-access/hydrate-options#hydrateoptions">HydrateOptions</DocsLink>), any related ProductVariant will have the correct
 Channel-specific prices applied to them.
 
 Custom field relations may also be hydrated:

package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx

@@ -2,13 +2,9 @@
 title: "GetEntityOrThrowOptions"
 generated: true
 ---
-
-
-## GetEntityOrThrowOptions
-
 <GenerationInfo sourceFile="packages/core/src/connection/types.ts" sourceLine="10" packageName="@vendure/core" />
 
-Options used by the <a href='/reference/typescript-api/data-access/transactional-connection#transactionalconnection'>TransactionalConnection</a> `getEntityOrThrow` method.
+Options used by the <DocsLink href="/reference/typescript-api/data-access/transactional-connection#transactionalconnection">TransactionalConnection</DocsLink> `getEntityOrThrow` method.
 
 ```ts title="Signature"
 interface GetEntityOrThrowOptions<T = any> extends FindOneOptions<T> {
@@ -29,7 +25,7 @@ interface GetEntityOrThrowOptions<T = any> extends FindOneOptions<T> {
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/id#id'>ID</a>`}   />
 
 An optional channelId to limit results to entities assigned to the given Channel. Should
-only be used when getting entities that implement the <a href='/reference/typescript-api/entities/interfaces#channelaware'>ChannelAware</a> interface.
+only be used when getting entities that implement the <DocsLink href="/reference/typescript-api/entities/interfaces#channelaware">ChannelAware</DocsLink> interface.
 ### retries
 
 <MemberInfo kind="property" type={`number`} default={`0`}  since="1.1.0"  />

package/docs/reference/typescript-api/data-access/hydrate-options.mdx

@@ -2,14 +2,10 @@
 title: "HydrateOptions"
 generated: true
 ---
-
-
-## HydrateOptions
-
 <GenerationInfo sourceFile="packages/core/src/service/helpers/entity-hydrator/entity-hydrator-types.ts" sourceLine="12" packageName="@vendure/core" since="1.3.0" />
 
 Options used to control which relations of the entity get hydrated
-when using the <a href='/reference/typescript-api/data-access/entity-hydrator#entityhydrator'>EntityHydrator</a> helper.
+when using the <DocsLink href="/reference/typescript-api/data-access/entity-hydrator#entityhydrator">EntityHydrator</DocsLink> helper.
 
 ```ts title="Signature"
 interface HydrateOptions<Entity extends VendureEntity> {

package/docs/reference/typescript-api/data-access/list-query-builder.mdx

@@ -2,13 +2,9 @@
 title: "ListQueryBuilder"
 generated: true
 ---
-
-
-## ListQueryBuilder
-
 <GenerationInfo sourceFile="packages/core/src/service/helpers/list-query-builder/list-query-builder.ts" sourceLine="207" packageName="@vendure/core" />
 
-This helper class is used when fetching entities the database from queries which return a <a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a> type.
+This helper class is used when fetching entities the database from queries which return a <DocsLink href="/reference/typescript-api/common/paginated-list#paginatedlist">PaginatedList</DocsLink> type.
 These queries all follow the same format:
 
 In the GraphQL definition, they return a type which implements the `Node` interface, and the query returns a
@@ -112,10 +108,6 @@ to join that relation.
 
 
 </div>
-
-
-## ExtendedListQueryOptions
-
 <GenerationInfo sourceFile="packages/core/src/service/helpers/list-query-builder/list-query-builder.ts" sourceLine="48" packageName="@vendure/core" />
 
 Options which can be passed to the ListQueryBuilder's `build()` method.

package/docs/reference/typescript-api/data-access/transactional-connection.mdx

@@ -2,14 +2,10 @@
 title: "TransactionalConnection"
 generated: true
 ---
-
-
-## TransactionalConnection
-
 <GenerationInfo sourceFile="packages/core/src/connection/transactional-connection.ts" sourceLine="41" packageName="@vendure/core" />
 
 The TransactionalConnection is a wrapper around the TypeORM `Connection` object which works in conjunction
-with the <a href='/reference/typescript-api/request/transaction-decorator#transaction'>Transaction</a> decorator to implement per-request transactions. All services which access the
+with the <DocsLink href="/reference/typescript-api/request/transaction-decorator#transaction">Transaction</DocsLink> decorator to implement per-request transactions. All services which access the
 database should use this class rather than the raw TypeORM connection, to ensure that db changes can be
 easily wrapped in transactions when required.
 
@@ -66,7 +62,7 @@ is discouraged without a deliberate reason.
 
 Returns a TypeORM repository which is bound to any existing transactions. It is recommended to _always_ pass
 the RequestContext argument when possible, otherwise the queries will be executed outside of any
-ongoing transactions which have been started by the <a href='/reference/typescript-api/request/transaction-decorator#transaction'>Transaction</a> decorator.
+ongoing transactions which have been started by the <DocsLink href="/reference/typescript-api/request/transaction-decorator#transaction">Transaction</DocsLink> decorator.
 
 The `options` parameter allows specifying additional configurations, such as the `replicationMode`,
 which determines whether the repository should interact with the master or replica database.
@@ -84,7 +80,7 @@ or not. If `RequestContext` is provided, the repository is bound to any ongoing
 Allows database operations to be wrapped in a transaction, ensuring that in the event of an error being
 thrown at any point, the entire transaction will be rolled back and no changes will be saved.
 
-In the context of API requests, you should instead use the <a href='/reference/typescript-api/request/transaction-decorator#transaction'>Transaction</a> decorator on your resolver or
+In the context of API requests, you should instead use the <DocsLink href="/reference/typescript-api/request/transaction-decorator#transaction">Transaction</DocsLink> decorator on your resolver or
 controller method.
 
 On the other hand, for code that does not run in the context of a GraphQL/REST request, this method
@@ -94,7 +90,7 @@ inconsistent state.
 Such situations include function processed by the JobQueue or stand-alone scripts which make use
 of Vendure internal services.
 
-If there is already a <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> object available, you should pass it in as the first
+If there is already a <DocsLink href="/reference/typescript-api/request/request-context#requestcontext">RequestContext</DocsLink> object available, you should pass it in as the first
 argument in order to create transactional context as the copy. If not, omit the first argument and an empty
 RequestContext object will be created, which is then used to propagate the transaction to
 all inner method calls.
@@ -133,12 +129,12 @@ private async transferCredit(outerCtx: RequestContext, fromId: ID, toId: ID, amo
 <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, isolationLevel?: <a href='/reference/typescript-api/request/transaction-decorator#transactionisolationlevel'>TransactionIsolationLevel</a>) => `}   />
 
 Manually start a transaction if one is not already in progress. This method should be used in
-conjunction with the `'manual'` mode of the <a href='/reference/typescript-api/request/transaction-decorator#transaction'>Transaction</a> decorator.
+conjunction with the `'manual'` mode of the <DocsLink href="/reference/typescript-api/request/transaction-decorator#transaction">Transaction</DocsLink> decorator.
 ### commitOpenTransaction
 
 <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => `}   />
 
-Manually commits any open transaction. Should be very rarely needed, since the <a href='/reference/typescript-api/request/transaction-decorator#transaction'>Transaction</a> decorator
+Manually commits any open transaction. Should be very rarely needed, since the <DocsLink href="/reference/typescript-api/request/transaction-decorator#transaction">Transaction</DocsLink> decorator
 and the internal TransactionInterceptor take care of this automatically. Use-cases include situations
 in which the worker thread needs to access changes made in the current transaction, or when using the
 Transaction decorator in manual mode.
@@ -146,7 +142,7 @@ Transaction decorator in manual mode.
 
 <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => `}   />
 
-Manually rolls back any open transaction. Should be very rarely needed, since the <a href='/reference/typescript-api/request/transaction-decorator#transaction'>Transaction</a> decorator
+Manually rolls back any open transaction. Should be very rarely needed, since the <DocsLink href="/reference/typescript-api/request/transaction-decorator#transaction">Transaction</DocsLink> decorator
 and the internal TransactionInterceptor take care of this automatically. Use-cases include when using the
 Transaction decorator in manual mode.
 ### getEntityOrThrow

package/docs/reference/typescript-api/default-search-plugin/default-search-plugin-init-options.mdx

@@ -2,10 +2,6 @@
 title: "DefaultSearchPluginInitOptions"
 generated: true
 ---
-
-
-## DefaultSearchPluginInitOptions
-
 <GenerationInfo sourceFile="packages/core/src/plugin/default-search-plugin/types.ts" sourceLine="15" packageName="@vendure/core" />
 
 Options which configure the behaviour of the DefaultSearchPlugin
@@ -43,8 +39,8 @@ the worker.
 
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/default-search-plugin/search-strategy#searchstrategy'>SearchStrategy</a>`} default={`undefined`}  since="1.6.0"  />
 
-Set a custom search strategy that implements <a href='/reference/typescript-api/default-search-plugin/search-strategy#searchstrategy'>SearchStrategy</a> or extends an existing search strategy
-such as <a href='/reference/typescript-api/default-search-plugin/mysql-search-strategy#mysqlsearchstrategy'>MysqlSearchStrategy</a>, <a href='/reference/typescript-api/default-search-plugin/postgres-search-strategy#postgressearchstrategy'>PostgresSearchStrategy</a> or <a href='/reference/typescript-api/default-search-plugin/sqlite-search-strategy#sqlitesearchstrategy'>SqliteSearchStrategy</a>.
+Set a custom search strategy that implements <DocsLink href="/reference/typescript-api/default-search-plugin/search-strategy#searchstrategy">SearchStrategy</DocsLink> or extends an existing search strategy
+such as <DocsLink href="/reference/typescript-api/default-search-plugin/mysql-search-strategy#mysqlsearchstrategy">MysqlSearchStrategy</DocsLink>, <DocsLink href="/reference/typescript-api/default-search-plugin/postgres-search-strategy#postgressearchstrategy">PostgresSearchStrategy</DocsLink> or <DocsLink href="/reference/typescript-api/default-search-plugin/sqlite-search-strategy#sqlitesearchstrategy">SqliteSearchStrategy</DocsLink>.
 
 *Example*
 

package/docs/reference/typescript-api/default-search-plugin/index.mdx

@@ -2,10 +2,6 @@
 title: "DefaultSearchPlugin"
 generated: true
 ---
-
-
-## DefaultSearchPlugin
-
 <GenerationInfo sourceFile="packages/core/src/plugin/default-search-plugin/default-search-plugin.ts" sourceLine="70" packageName="@vendure/core" />
 
 The DefaultSearchPlugin provides a full-text Product search based on the full-text searching capabilities of the

package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx

@@ -2,10 +2,6 @@
 title: "MysqlSearchStrategy"
 generated: true
 ---
-
-
-## MysqlSearchStrategy
-
 <GenerationInfo sourceFile="packages/core/src/plugin/default-search-plugin/search-strategy/mysql-search-strategy.ts" sourceLine="28" packageName="@vendure/core" />
 
 A weighted fulltext search for MySQL / MariaDB.

package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx

@@ -2,10 +2,6 @@
 title: "PostgresSearchStrategy"
 generated: true
 ---
-
-
-## PostgresSearchStrategy
-
 <GenerationInfo sourceFile="packages/core/src/plugin/default-search-plugin/search-strategy/postgres-search-strategy.ts" sourceLine="28" packageName="@vendure/core" />
 
 A weighted fulltext search for PostgeSQL.

package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx

@@ -2,10 +2,6 @@
 title: "SearchStrategy"
 generated: true
 ---
-
-
-## SearchStrategy
-
 <GenerationInfo sourceFile="packages/core/src/plugin/default-search-plugin/search-strategy/search-strategy.ts" sourceLine="21" packageName="@vendure/core" />
 
 This interface defines the contract that any database-specific search implementations
@@ -14,7 +10,7 @@ should follow.
 :::info
 
 This is configured via the `searchStrategy` property of
-the <a href='/reference/typescript-api/default-search-plugin/default-search-plugin-init-options#defaultsearchplugininitoptions'>DefaultSearchPluginInitOptions</a>.
+the <DocsLink href="/reference/typescript-api/default-search-plugin/default-search-plugin-init-options#defaultsearchplugininitoptions">DefaultSearchPluginInitOptions</DocsLink>.
 
 :::
 

package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx

@@ -2,10 +2,6 @@
 title: "SqliteSearchStrategy"
 generated: true
 ---
-
-
-## SqliteSearchStrategy
-
 <GenerationInfo sourceFile="packages/core/src/plugin/default-search-plugin/search-strategy/sqlite-search-strategy.ts" sourceLine="30" packageName="@vendure/core" />
 
 A rather naive search for SQLite / SQL.js. Rather than proper

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

@@ -2,13 +2,9 @@
 title: "Address"
 generated: true
 ---
-
-
-## Address
-
 <GenerationInfo sourceFile="packages/core/src/entity/address/address.entity.ts" sourceLine="16" packageName="@vendure/core" />
 
-Represents a <a href='/reference/typescript-api/entities/customer#customer'>Customer</a>'s address.
+Represents a <DocsLink href="/reference/typescript-api/entities/customer#customer">Customer</DocsLink>'s address.
 
 ```ts title="Signature"
 class Address extends VendureEntity implements HasCustomFields {

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

@@ -2,15 +2,11 @@
 title: "Administrator"
 generated: true
 ---
-
-
-## Administrator
-
 <GenerationInfo sourceFile="packages/core/src/entity/administrator/administrator.entity.ts" sourceLine="18" packageName="@vendure/core" />
 
 An administrative user who has access to the Admin UI and Admin API. The
 specific permissions of the Administrator are determined by the assigned
-<a href='/reference/typescript-api/entities/role#role'>Role</a>s.
+<DocsLink href="/reference/typescript-api/entities/role#role">Role</DocsLink>s.
 
 ```ts title="Signature"
 class Administrator extends VendureEntity implements SoftDeletable, HasCustomFields {

package/docs/reference/typescript-api/entities/anonymous-session.mdx

@@ -2,10 +2,6 @@
 title: "AnonymousSession"
 generated: true
 ---
-
-
-## AnonymousSession
-
 <GenerationInfo sourceFile="packages/core/src/entity/session/anonymous-session.entity.ts" sourceLine="16" packageName="@vendure/core" />
 
 An anonymous session is created when a unauthenticated user interacts with restricted operations,

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

@@ -2,10 +2,6 @@
 title: "Asset"
 generated: true
 ---
-
-
-## Asset
-
 <GenerationInfo sourceFile="packages/core/src/entity/asset/asset.entity.ts" sourceLine="22" packageName="@vendure/core" />
 
 An Asset represents a file such as an image which can be associated with certain other entities

package/docs/reference/typescript-api/entities/authenticated-session.mdx

@@ -2,10 +2,6 @@
 title: "AuthenticatedSession"
 generated: true
 ---
-
-
-## AuthenticatedSession
-
 <GenerationInfo sourceFile="packages/core/src/entity/session/authenticated-session.entity.ts" sourceLine="14" packageName="@vendure/core" />
 
 An AuthenticatedSession is created upon successful authentication.
@@ -35,12 +31,12 @@ class AuthenticatedSession extends Session {
 
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/user#user'>User</a>`}   />
 
-The <a href='/reference/typescript-api/entities/user#user'>User</a> who has authenticated to create this session.
+The <DocsLink href="/reference/typescript-api/entities/user#user">User</DocsLink> who has authenticated to create this session.
 ### authenticationStrategy
 
 <MemberInfo kind="property" type={`string`}   />
 
-The name of the <a href='/reference/typescript-api/auth/authentication-strategy#authenticationstrategy'>AuthenticationStrategy</a> used when authenticating
+The name of the <DocsLink href="/reference/typescript-api/auth/authentication-strategy#authenticationstrategy">AuthenticationStrategy</DocsLink> used when authenticating
 to create this session.
 
 

package/docs/reference/typescript-api/entities/authentication-method.mdx

@@ -2,14 +2,10 @@
 title: "AuthenticationMethod"
 generated: true
 ---
-
-
-## AuthenticationMethod
-
 <GenerationInfo sourceFile="packages/core/src/entity/authentication-method/authentication-method.entity.ts" sourceLine="14" packageName="@vendure/core" />
 
-An AuthenticationMethod represents the means by which a <a href='/reference/typescript-api/entities/user#user'>User</a> is authenticated. There are two kinds:
-<a href='/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod'>NativeAuthenticationMethod</a> and <a href='/reference/typescript-api/entities/authentication-method#externalauthenticationmethod'>ExternalAuthenticationMethod</a>.
+An AuthenticationMethod represents the means by which a <DocsLink href="/reference/typescript-api/entities/user#user">User</DocsLink> is authenticated. There are two kinds:
+<DocsLink href="/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod">NativeAuthenticationMethod</DocsLink> and <DocsLink href="/reference/typescript-api/entities/authentication-method#externalauthenticationmethod">ExternalAuthenticationMethod</DocsLink>.
 
 ```ts title="Signature"
 class AuthenticationMethod extends VendureEntity {
@@ -32,10 +28,6 @@ class AuthenticationMethod extends VendureEntity {
 
 
 </div>
-
-
-## ExternalAuthenticationMethod
-
 <GenerationInfo sourceFile="packages/core/src/entity/authentication-method/external-authentication-method.entity.ts" sourceLine="14" packageName="@vendure/core" />
 
 This method is used when an external authentication service is used to authenticate Vendure Users.
@@ -81,10 +73,6 @@ class ExternalAuthenticationMethod extends AuthenticationMethod {
 
 
 </div>
-
-
-## NativeAuthenticationMethod
-
 <GenerationInfo sourceFile="packages/core/src/entity/authentication-method/native-authentication-method.entity.ts" sourceLine="14" packageName="@vendure/core" />
 
 This is the default, built-in authentication method which uses a identifier (typically username or email address)