@vendure/docs 0.0.0-202601201808 → 0.0.0-202601211028

package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx

@@ -2,13 +2,9 @@
 title: "JobQueueStrategy"
 generated: true
 ---
-
-
-## JobQueueStrategy
-
 <GenerationInfo sourceFile="packages/core/src/config/job-queue/job-queue-strategy.ts" sourceLine="24" packageName="@vendure/core" />
 
-Defines how the jobs in the <a href='/reference/typescript-api/job-queue/job-queue-service#jobqueueservice'>JobQueueService</a> are persisted and
+Defines how the jobs in the <DocsLink href="/reference/typescript-api/job-queue/job-queue-service#jobqueueservice">JobQueueService</DocsLink> are persisted and
 accessed. Custom strategies can be defined to make use of external
 services such as Redis.
 
@@ -40,17 +36,17 @@ interface JobQueueStrategy extends InjectableStrategy {
 
 ### add
 
-<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>&#60;Data&#62;, jobOptions?: JobQueueStrategyJobOptions&#60;Data&#62;) => Promise&#60;<a href='/reference/typescript-api/job-queue/job#job'>Job</a>&#60;Data&#62;&#62;`}   />
+<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>, jobOptions?: JobQueueStrategyJobOptions<Data>) => Promise<<a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>>`}   />
 
 Add a new job to the queue.
 ### start
 
-<MemberInfo kind="method" type={`(queueName: string, process: (job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>&#60;Data&#62;) =&#62; Promise&#60;any&#62;) => Promise&#60;void&#62;`}   />
+<MemberInfo kind="method" type={`(queueName: string, process: (job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>) => Promise<any>) => Promise<void>`}   />
 
 Start the job queue
 ### stop
 
-<MemberInfo kind="method" type={`(queueName: string, process: (job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>&#60;Data&#62;) =&#62; Promise&#60;any&#62;) => Promise&#60;void&#62;`}   />
+<MemberInfo kind="method" type={`(queueName: string, process: (job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>) => Promise<any>) => Promise<void>`}   />
 
 Stops a queue from running. Its not guaranteed to stop immediately.
 

package/docs/reference/typescript-api/job-queue/job.mdx

@@ -2,15 +2,11 @@
 title: "Job"
 generated: true
 ---
-
-
-## Job
-
 <GenerationInfo sourceFile="packages/core/src/job-queue/job.ts" sourceLine="37" packageName="@vendure/core" />
 
 A Job represents a piece of work to be run in the background, i.e. outside the request-response cycle.
 It is intended to be used for long-running work triggered by API requests. Jobs should now generally
-be directly instantiated. Rather, the <a href='/reference/typescript-api/job-queue/#jobqueue'>JobQueue</a> `add()` method should be used to create and
+be directly instantiated. Rather, the <DocsLink href="/reference/typescript-api/job-queue/#jobqueue">JobQueue</DocsLink> `add()` method should be used to create and
 add a new Job to a queue.
 
 ```ts title="Signature"
@@ -121,7 +117,7 @@ class Job<T extends JobData<T> = any> {
 
 ### constructor
 
-<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/job-queue/types#jobconfig'>JobConfig</a>&#60;T&#62;) => Job`}   />
+<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/job-queue/types#jobconfig'>JobConfig</a><T>) => Job`}   />
 
 
 ### start
@@ -129,7 +125,7 @@ class Job<T extends JobData<T> = any> {
 <MemberInfo kind="method" type={`() => `}   />
 
 Calling this signifies that the job work has started. This method should be
-called in the <a href='/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy'>JobQueueStrategy</a> `next()` method.
+called in the <DocsLink href="/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy">JobQueueStrategy</DocsLink> `next()` method.
 ### setProgress
 
 <MemberInfo kind="method" type={`(percent: number) => `}   />
@@ -159,21 +155,17 @@ Sets a RUNNING job back to PENDING. Should be used when the JobQueue is being
 destroyed before the job has been completed.
 ### on
 
-<MemberInfo kind="method" type={`(eventType: <a href='/reference/typescript-api/job-queue/job#jobeventtype'>JobEventType</a>, listener: <a href='/reference/typescript-api/job-queue/job#jobeventlistener'>JobEventListener</a>&#60;T&#62;) => `}   />
+<MemberInfo kind="method" type={`(eventType: <a href='/reference/typescript-api/job-queue/job#jobeventtype'>JobEventType</a>, listener: <a href='/reference/typescript-api/job-queue/job#jobeventlistener'>JobEventListener</a><T>) => `}   />
 
 Used to register event handler for job events
 ### off
 
-<MemberInfo kind="method" type={`(eventType: <a href='/reference/typescript-api/job-queue/job#jobeventtype'>JobEventType</a>, listener: <a href='/reference/typescript-api/job-queue/job#jobeventlistener'>JobEventListener</a>&#60;T&#62;) => `}   />
+<MemberInfo kind="method" type={`(eventType: <a href='/reference/typescript-api/job-queue/job#jobeventtype'>JobEventType</a>, listener: <a href='/reference/typescript-api/job-queue/job#jobeventlistener'>JobEventListener</a><T>) => `}   />
 
 
 
 
 </div>
-
-
-## JobEventType
-
 <GenerationInfo sourceFile="packages/core/src/job-queue/job.ts" sourceLine="15" packageName="@vendure/core" />
 
 An event raised by a Job.
@@ -181,10 +173,6 @@ An event raised by a Job.
 ```ts title="Signature"
 type JobEventType = 'progress'
 ```
-
-
-## JobEventListener
-
 <GenerationInfo sourceFile="packages/core/src/job-queue/job.ts" sourceLine="24" packageName="@vendure/core" />
 
 The signature of the event handler expected by the `Job.on()` method.

package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx

@@ -2,17 +2,13 @@
 title: "PollingJobQueueStrategy"
 generated: true
 ---
-
-
-## PollingJobQueueStrategy
-
 <GenerationInfo sourceFile="packages/core/src/job-queue/polling-job-queue-strategy.ts" sourceLine="242" packageName="@vendure/core" />
 
-This class allows easier implementation of <a href='/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy'>JobQueueStrategy</a> in a polling style.
-Instead of providing <a href='/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy'>JobQueueStrategy</a> `start()` you should provide a `next` method.
+This class allows easier implementation of <DocsLink href="/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy">JobQueueStrategy</DocsLink> in a polling style.
+Instead of providing <DocsLink href="/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy">JobQueueStrategy</DocsLink> `start()` you should provide a `next` method.
 
 This class should be extended by any strategy which does not support a push-based system
-to notify on new jobs. It is used by the <a href='/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy'>SqlJobQueueStrategy</a> and <a href='/reference/typescript-api/job-queue/in-memory-job-queue-strategy#inmemoryjobqueuestrategy'>InMemoryJobQueueStrategy</a>.
+to notify on new jobs. It is used by the <DocsLink href="/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy">SqlJobQueueStrategy</DocsLink> and <DocsLink href="/reference/typescript-api/job-queue/in-memory-job-queue-strategy#inmemoryjobqueuestrategy">InMemoryJobQueueStrategy</DocsLink>.
 
 ```ts title="Signature"
 class PollingJobQueueStrategy extends InjectableJobQueueStrategy {
@@ -46,12 +42,12 @@ class PollingJobQueueStrategy extends InjectableJobQueueStrategy {
 
 ### pollInterval
 
-<MemberInfo kind="property" type={`number | ((queueName: string) =&#62; number)`}   />
+<MemberInfo kind="property" type={`number | ((queueName: string) => number)`}   />
 
 
 ### setRetries
 
-<MemberInfo kind="property" type={`(queueName: string, job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>) =&#62; number`}   />
+<MemberInfo kind="property" type={`(queueName: string, job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>) => number`}   />
 
 
 ### backOffStrategy
@@ -86,34 +82,34 @@ class PollingJobQueueStrategy extends InjectableJobQueueStrategy {
 
 ### start
 
-<MemberInfo kind="method" type={`(queueName: string, process: (job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>&#60;Data&#62;) =&#62; Promise&#60;any&#62;) => `}   />
+<MemberInfo kind="method" type={`(queueName: string, process: (job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>) => Promise<any>) => `}   />
 
 
 ### stop
 
-<MemberInfo kind="method" type={`(queueName: string, process: (job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>&#60;Data&#62;) =&#62; Promise&#60;any&#62;) => `}   />
+<MemberInfo kind="method" type={`(queueName: string, process: (job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>) => Promise<any>) => `}   />
 
 
 ### cancelJob
 
-<MemberInfo kind="method" type={`(jobId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;<a href='/reference/typescript-api/job-queue/job#job'>Job</a> | undefined&#62;`}   />
+<MemberInfo kind="method" type={`(jobId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/job-queue/job#job'>Job</a> | undefined>`}   />
 
 
 ### next
 
-<MemberInfo kind="method" type={`(queueName: string) => Promise&#60;<a href='/reference/typescript-api/job-queue/job#job'>Job</a> | undefined&#62;`}   />
+<MemberInfo kind="method" type={`(queueName: string) => Promise<<a href='/reference/typescript-api/job-queue/job#job'>Job</a> | undefined>`}   />
 
 Should return the next job in the given queue. The implementation is
 responsible for returning the correct job according to the time of
 creation.
 ### update
 
-<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>) => Promise&#60;void&#62;`}   />
+<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>) => Promise<void>`}   />
 
 Update the job details in the store.
 ### findOne
 
-<MemberInfo kind="method" type={`(id: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;<a href='/reference/typescript-api/job-queue/job#job'>Job</a> | undefined&#62;`}   />
+<MemberInfo kind="method" type={`(id: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/job-queue/job#job'>Job</a> | undefined>`}   />
 
 Returns a job by its id.
 

package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx

@@ -2,14 +2,10 @@
 title: "SqlJobQueueStrategy"
 generated: true
 ---
-
-
-## SqlJobQueueStrategy
-
 <GenerationInfo sourceFile="packages/core/src/plugin/default-job-queue-plugin/sql-job-queue-strategy.ts" sourceLine="22" packageName="@vendure/core" />
 
-A <a href='/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy'>JobQueueStrategy</a> which uses the configured SQL database to persist jobs in the queue.
-This strategy is used by the <a href='/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin'>DefaultJobQueuePlugin</a>.
+A <DocsLink href="/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy">JobQueueStrategy</DocsLink> which uses the configured SQL database to persist jobs in the queue.
+This strategy is used by the <DocsLink href="/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin">DefaultJobQueuePlugin</DocsLink>.
 
 ```ts title="Signature"
 class SqlJobQueueStrategy extends PollingJobQueueStrategy implements InspectableJobQueueStrategy {
@@ -45,32 +41,32 @@ class SqlJobQueueStrategy extends PollingJobQueueStrategy implements Inspectable
 
 ### add
 
-<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>&#60;Data&#62;, jobOptions?: JobQueueStrategyJobOptions&#60;Data&#62;) => Promise&#60;<a href='/reference/typescript-api/job-queue/job#job'>Job</a>&#60;Data&#62;&#62;`}   />
+<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>, jobOptions?: JobQueueStrategyJobOptions<Data>) => Promise<<a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>>`}   />
 
 
 ### next
 
-<MemberInfo kind="method" type={`(queueName: string) => Promise&#60;<a href='/reference/typescript-api/job-queue/job#job'>Job</a> | undefined&#62;`}   />
+<MemberInfo kind="method" type={`(queueName: string) => Promise<<a href='/reference/typescript-api/job-queue/job#job'>Job</a> | undefined>`}   />
 
 
 ### update
 
-<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>&#60;any&#62;) => Promise&#60;void&#62;`}   />
+<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a><any>) => Promise<void>`}   />
 
 
 ### findMany
 
-<MemberInfo kind="method" type={`(options?: JobListOptions) => Promise&#60;<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>&#60;<a href='/reference/typescript-api/job-queue/job#job'>Job</a>&#62;&#62;`}   />
+<MemberInfo kind="method" type={`(options?: JobListOptions) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><<a href='/reference/typescript-api/job-queue/job#job'>Job</a>>>`}   />
 
 
 ### findOne
 
-<MemberInfo kind="method" type={`(id: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;<a href='/reference/typescript-api/job-queue/job#job'>Job</a> | undefined&#62;`}   />
+<MemberInfo kind="method" type={`(id: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/job-queue/job#job'>Job</a> | undefined>`}   />
 
 
 ### findManyById
 
-<MemberInfo kind="method" type={`(ids: <a href='/reference/typescript-api/common/id#id'>ID</a>[]) => Promise&#60;<a href='/reference/typescript-api/job-queue/job#job'>Job</a>[]&#62;`}   />
+<MemberInfo kind="method" type={`(ids: <a href='/reference/typescript-api/common/id#id'>ID</a>[]) => Promise<<a href='/reference/typescript-api/job-queue/job#job'>Job</a>[]>`}   />
 
 
 ### removeSettledJobs

package/docs/reference/typescript-api/job-queue/subscribable-job.mdx

@@ -2,16 +2,12 @@
 title: "SubscribableJob"
 generated: true
 ---
-
-
-## SubscribableJob
-
 <GenerationInfo sourceFile="packages/core/src/job-queue/subscribable-job.ts" sourceLine="59" packageName="@vendure/core" />
 
 This is a type of Job object that allows you to subscribe to updates to the Job. It is returned
-by the <a href='/reference/typescript-api/job-queue/#jobqueue'>JobQueue</a>'s `add()` method. Note that the subscription capability is only supported
-if the <a href='/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy'>JobQueueStrategy</a> implements the <a href='/reference/typescript-api/job-queue/inspectable-job-queue-strategy#inspectablejobqueuestrategy'>InspectableJobQueueStrategy</a> interface (e.g.
-the <a href='/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy'>SqlJobQueueStrategy</a> does support this).
+by the <DocsLink href="/reference/typescript-api/job-queue/#jobqueue">JobQueue</DocsLink>'s `add()` method. Note that the subscription capability is only supported
+if the <DocsLink href="/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy">JobQueueStrategy</DocsLink> implements the <DocsLink href="/reference/typescript-api/job-queue/inspectable-job-queue-strategy#inspectablejobqueuestrategy">InspectableJobQueueStrategy</DocsLink> interface (e.g.
+the <DocsLink href="/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy">SqlJobQueueStrategy</DocsLink> does support this).
 
 ```ts title="Signature"
 class SubscribableJob<T extends JobData<T> = any> extends Job<T> {
@@ -19,7 +15,7 @@ class SubscribableJob<T extends JobData<T> = any> extends Job<T> {
     updates(options?: JobUpdateOptions) => Observable<JobUpdate<T>>;
 }
 ```
-* Extends: <code><a href='/reference/typescript-api/job-queue/job#job'>Job</a>&#60;T&#62;</code>
+* Extends: <code><a href='/reference/typescript-api/job-queue/job#job'>Job</a><T></code>
 
 
 
@@ -27,17 +23,17 @@ class SubscribableJob<T extends JobData<T> = any> extends Job<T> {
 
 ### constructor
 
-<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>&#60;T&#62;, jobQueueStrategy: <a href='/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy'>JobQueueStrategy</a>) => SubscribableJob`}   />
+<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a><T>, jobQueueStrategy: <a href='/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy'>JobQueueStrategy</a>) => SubscribableJob`}   />
 
 
 ### updates
 
-<MemberInfo kind="method" type={`(options?: <a href='/reference/typescript-api/job-queue/types#jobupdateoptions'>JobUpdateOptions</a>) => Observable&#60;<a href='/reference/typescript-api/job-queue/types#jobupdate'>JobUpdate</a>&#60;T&#62;&#62;`}   />
+<MemberInfo kind="method" type={`(options?: <a href='/reference/typescript-api/job-queue/types#jobupdateoptions'>JobUpdateOptions</a>) => Observable<<a href='/reference/typescript-api/job-queue/types#jobupdate'>JobUpdate</a><T>>`}   />
 
 Returns an Observable stream of updates to the Job. Works by polling the current JobQueueStrategy's `findOne()` method
 to obtain updates. If the updates are not subscribed to, then no polling occurs.
 
-Polling interval, timeout and other options may be configured with an options arguments <a href='/reference/typescript-api/job-queue/types#jobupdateoptions'>JobUpdateOptions</a>.
+Polling interval, timeout and other options may be configured with an options arguments <DocsLink href="/reference/typescript-api/job-queue/types#jobupdateoptions">JobUpdateOptions</DocsLink>.
 
 
 </div>

package/docs/reference/typescript-api/job-queue/types.mdx

@@ -2,10 +2,6 @@
 title: "Types"
 generated: true
 ---
-
-
-## BackoffStrategy
-
 <GenerationInfo sourceFile="packages/core/src/job-queue/polling-job-queue-strategy.ts" sourceLine="22" packageName="@vendure/core" />
 
 Defines the backoff strategy used when retrying failed jobs. Returns the delay in
@@ -14,13 +10,9 @@ ms that should pass before the failed job is retried.
 ```ts title="Signature"
 type BackoffStrategy = (queueName: string, attemptsMade: number, job: Job) => number
 ```
-
-
-## JobUpdate
-
 <GenerationInfo sourceFile="packages/core/src/job-queue/subscribable-job.ts" sourceLine="23" packageName="@vendure/core" />
 
-Job update status as returned from the <a href='/reference/typescript-api/job-queue/subscribable-job#subscribablejob'>SubscribableJob</a>'s `update()` method.
+Job update status as returned from the <DocsLink href="/reference/typescript-api/job-queue/subscribable-job#subscribablejob">SubscribableJob</DocsLink>'s `update()` method.
 
 ```ts title="Signature"
 type JobUpdate<T extends JobData<T>> = Pick<
@@ -28,13 +20,9 @@ type JobUpdate<T extends JobData<T>> = Pick<
     'id' | 'state' | 'progress' | 'result' | 'error' | 'data'
 >
 ```
-
-
-## JobUpdateOptions
-
 <GenerationInfo sourceFile="packages/core/src/job-queue/subscribable-job.ts" sourceLine="35" packageName="@vendure/core" />
 
-Job update options, that you can specify by calling <a href='/reference/typescript-api/job-queue/subscribable-job#subscribablejob'>SubscribableJob</a> `updates` method.
+Job update options, that you can specify by calling <DocsLink href="/reference/typescript-api/job-queue/subscribable-job#subscribablejob">SubscribableJob</DocsLink> `updates` method.
 
 ```ts title="Signature"
 type JobUpdateOptions = {
@@ -64,13 +52,9 @@ type JobUpdateOptions = {
 
 
 </div>
-
-
-## CreateQueueOptions
-
 <GenerationInfo sourceFile="packages/core/src/job-queue/types.ts" sourceLine="15" packageName="@vendure/core" />
 
-Used to configure a new <a href='/reference/typescript-api/job-queue/#jobqueue'>JobQueue</a> instance.
+Used to configure a new <DocsLink href="/reference/typescript-api/job-queue/#jobqueue">JobQueue</DocsLink> instance.
 
 ```ts title="Signature"
 interface CreateQueueOptions<T extends JobData<T>> {
@@ -88,31 +72,23 @@ interface CreateQueueOptions<T extends JobData<T>> {
 The name of the queue, e.g. "image processing", "re-indexing" etc.
 ### process
 
-<MemberInfo kind="property" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>&#60;T&#62;) =&#62; Promise&#60;any&#62;`}   />
+<MemberInfo kind="property" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a><T>) => Promise<any>`}   />
 
 Defines the work to be done for each job in the queue. The returned promise
 should resolve when the job is complete, or be rejected in case of an error.
 
 
 </div>
-
-
-## JobData
-
 <GenerationInfo sourceFile="packages/core/src/job-queue/types.ts" sourceLine="37" packageName="@vendure/core" />
 
-A JSON-serializable data type which provides a <a href='/reference/typescript-api/job-queue/job#job'>Job</a>with the data it needs to be processed.
+A JSON-serializable data type which provides a <DocsLink href="/reference/typescript-api/job-queue/job#job">Job</DocsLink>with the data it needs to be processed.
 
 ```ts title="Signature"
 type JobData<T> = JsonCompatible<T>
 ```
-
-
-## JobConfig
-
 <GenerationInfo sourceFile="packages/core/src/job-queue/types.ts" sourceLine="46" packageName="@vendure/core" />
 
-Used to instantiate a new <a href='/reference/typescript-api/job-queue/job#job'>Job</a>
+Used to instantiate a new <DocsLink href="/reference/typescript-api/job-queue/job#job">Job</DocsLink>
 
 ```ts title="Signature"
 interface JobConfig<T extends JobData<T>> {

package/docs/reference/typescript-api/logger/default-logger.mdx

@@ -2,10 +2,6 @@
 title: "DefaultLogger"
 generated: true
 ---
-
-
-## DefaultLogger
-
 <GenerationInfo sourceFile="packages/core/src/config/logger/default-logger.ts" sourceLine="25" packageName="@vendure/core" />
 
 The default logger, which logs to the console (stdout) with optional timestamps. Since this logger is part of the

package/docs/reference/typescript-api/logger/index.mdx

@@ -2,10 +2,6 @@
 title: "Logger"
 generated: true
 ---
-
-
-## Logger
-
 <GenerationInfo sourceFile="packages/core/src/config/logger/vendure-logger.ts" sourceLine="136" packageName="@vendure/core" />
 
 The Logger is responsible for all logging in a Vendure application.
@@ -20,14 +16,14 @@ import { Logger } from '@vendure/core';
 Logger.info(`Some log message`, 'My Vendure Plugin');
 ```
 
-The actual implementation - where the logs are written to - is defined by the <a href='/reference/typescript-api/logger/vendure-logger#vendurelogger'>VendureLogger</a>
-instance configured in the <a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>. By default, the <a href='/reference/typescript-api/logger/default-logger#defaultlogger'>DefaultLogger</a> is used, which
+The actual implementation - where the logs are written to - is defined by the <DocsLink href="/reference/typescript-api/logger/vendure-logger#vendurelogger">VendureLogger</DocsLink>
+instance configured in the <DocsLink href="/reference/typescript-api/configuration/vendure-config#vendureconfig">VendureConfig</DocsLink>. By default, the <DocsLink href="/reference/typescript-api/logger/default-logger#defaultlogger">DefaultLogger</DocsLink> is used, which
 logs to the console.
 
 ## Implementing a custom logger
 
 A custom logger can be passed to the `logger` config option by creating a class which implements the
-<a href='/reference/typescript-api/logger/vendure-logger#vendurelogger'>VendureLogger</a> interface. For example, here is how you might go about implementing a logger which
+<DocsLink href="/reference/typescript-api/logger/vendure-logger#vendurelogger">VendureLogger</DocsLink> interface. For example, here is how you might go about implementing a logger which
 logs to a file:
 
 *Example*

package/docs/reference/typescript-api/logger/log-level.mdx

@@ -2,10 +2,6 @@
 title: "LogLevel"
 generated: true
 ---
-
-
-## LogLevel
-
 <GenerationInfo sourceFile="packages/core/src/config/logger/vendure-logger.ts" sourceLine="9" packageName="@vendure/core" />
 
 An enum of valid logging levels.

package/docs/reference/typescript-api/logger/vendure-logger.mdx

@@ -2,10 +2,6 @@
 title: "VendureLogger"
 generated: true
 ---
-
-
-## VendureLogger
-
 <GenerationInfo sourceFile="packages/core/src/config/logger/vendure-logger.ts" sourceLine="47" packageName="@vendure/core" />
 
 The VendureLogger interface defines the shape of a logger service which may be provided in

package/docs/reference/typescript-api/migration/generate-migration.mdx

@@ -2,10 +2,6 @@
 title: "GenerateMigration"
 generated: true
 ---
-
-
-## generateMigration
-
 <GenerationInfo sourceFile="packages/core/src/migrate.ts" sourceLine="118" packageName="@vendure/core" />
 
 Generates a new migration file based on any schema changes (e.g. adding or removing CustomFields).
@@ -19,7 +15,7 @@ Parameters
 
 ### userConfig
 
-<MemberInfo kind="parameter" type={`Partial&#60;<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>&#62;`} />
+<MemberInfo kind="parameter" type={`Partial<<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>>`} />
 
 ### options
 

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

@@ -2,13 +2,9 @@
 title: "MigrationOptions"
 generated: true
 ---
-
-
-## MigrationOptions
-
 <GenerationInfo sourceFile="packages/core/src/migrate.ts" sourceLine="19" packageName="@vendure/core" />
 
-Configuration for generating a new migration script via <a href='/reference/typescript-api/migration/generate-migration#generatemigration'>generateMigration</a>.
+Configuration for generating a new migration script via <DocsLink href="/reference/typescript-api/migration/generate-migration#generatemigration">generateMigration</DocsLink>.
 
 ```ts title="Signature"
 interface MigrationOptions {

package/docs/reference/typescript-api/migration/revert-last-migration.mdx

@@ -2,10 +2,6 @@
 title: "RevertLastMigration"
 generated: true
 ---
-
-
-## revertLastMigration
-
 <GenerationInfo sourceFile="packages/core/src/migrate.ts" sourceLine="89" packageName="@vendure/core" />
 
 Reverts the last applied database migration. See [TypeORM migration docs](https://typeorm.io/#/migrations)
@@ -18,5 +14,5 @@ Parameters
 
 ### userConfig
 
-<MemberInfo kind="parameter" type={`Partial&#60;<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>&#62;`} />
+<MemberInfo kind="parameter" type={`Partial<<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>>`} />
 

package/docs/reference/typescript-api/migration/run-migrations.mdx

@@ -2,10 +2,6 @@
 title: "RunMigrations"
 generated: true
 ---
-
-
-## runMigrations
-
 <GenerationInfo sourceFile="packages/core/src/migrate.ts" sourceLine="40" packageName="@vendure/core" />
 
 Runs any pending database migrations. See [TypeORM migration docs](https://typeorm.io/#/migrations)
@@ -18,5 +14,5 @@ Parameters
 
 ### userConfig
 
-<MemberInfo kind="parameter" type={`Partial&#60;<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>&#62;`} />
+<MemberInfo kind="parameter" type={`Partial<<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>>`} />
 

package/docs/reference/typescript-api/money/big-int-money-strategy.mdx

@@ -2,17 +2,13 @@
 title: "BigIntMoneyStrategy"
 generated: true
 ---
-
-
-## BigIntMoneyStrategy
-
 <GenerationInfo sourceFile="packages/core/src/config/entity/bigint-money-strategy.ts" sourceLine="18" packageName="@vendure/core" since="2.0.0" />
 
-A <a href='/reference/typescript-api/money/money-strategy#moneystrategy'>MoneyStrategy</a> that stores monetary values as a `bigint` type in the database, which
+A <DocsLink href="/reference/typescript-api/money/money-strategy#moneystrategy">MoneyStrategy</DocsLink> that stores monetary values as a `bigint` type in the database, which
 allows values up to ~9 quadrillion to be stored (limited by JavaScript's `MAX_SAFE_INTEGER` limit).
 
 This strategy also slightly differs in the way rounding is performed, with rounding being done _after_
-multiplying the unit price, rather than before (as is the case with the <a href='/reference/typescript-api/money/default-money-strategy#defaultmoneystrategy'>DefaultMoneyStrategy</a>.
+multiplying the unit price, rather than before (as is the case with the <DocsLink href="/reference/typescript-api/money/default-money-strategy#defaultmoneystrategy">DefaultMoneyStrategy</DocsLink>.
 
 ```ts title="Signature"
 class BigIntMoneyStrategy implements MoneyStrategy {

package/docs/reference/typescript-api/money/default-money-strategy.mdx

@@ -2,13 +2,9 @@
 title: "DefaultMoneyStrategy"
 generated: true
 ---
-
-
-## DefaultMoneyStrategy
-
 <GenerationInfo sourceFile="packages/core/src/config/entity/default-money-strategy.ts" sourceLine="14" packageName="@vendure/core" since="2.0.0" />
 
-A <a href='/reference/typescript-api/money/money-strategy#moneystrategy'>MoneyStrategy</a> that stores monetary values as a `int` type in the database.
+A <DocsLink href="/reference/typescript-api/money/money-strategy#moneystrategy">MoneyStrategy</DocsLink> that stores monetary values as a `int` type in the database.
 The storage configuration and rounding logic replicates the behaviour of Vendure pre-2.0.
 
 ```ts title="Signature"

package/docs/reference/typescript-api/money/money-decorator.mdx

@@ -2,14 +2,10 @@
 title: "Money Decorator"
 generated: true
 ---
-
-
-## Money
-
 <GenerationInfo sourceFile="packages/core/src/entity/money.decorator.ts" sourceLine="26" packageName="@vendure/core" since="2.0.0" />
 
 Use this decorator for any entity field that is storing a monetary value.
-This allows the column type to be defined by the configured <a href='/reference/typescript-api/money/money-strategy#moneystrategy'>MoneyStrategy</a>.
+This allows the column type to be defined by the configured <DocsLink href="/reference/typescript-api/money/money-strategy#moneystrategy">MoneyStrategy</DocsLink>.
 
 ```ts title="Signature"
 function Money(options?: MoneyColumnOptions): void

package/docs/reference/typescript-api/money/money-strategy.mdx

@@ -2,14 +2,10 @@
 title: "MoneyStrategy"
 generated: true
 ---
-
-
-## MoneyStrategy
-
 <GenerationInfo sourceFile="packages/core/src/config/entity/money-strategy.ts" sourceLine="63" packageName="@vendure/core" since="2.0.0" />
 
 The MoneyStrategy defines how monetary values are stored and manipulated. The MoneyStrategy
-is defined in <a href='/reference/typescript-api/configuration/entity-options#entityoptions'>EntityOptions</a>:
+is defined in <DocsLink href="/reference/typescript-api/configuration/entity-options#entityoptions">EntityOptions</DocsLink>:
 
 *Example*
 
@@ -23,11 +19,11 @@ const config: VendureConfig = {
 
 ## Range
 
-The <a href='/reference/typescript-api/money/default-money-strategy#defaultmoneystrategy'>DefaultMoneyStrategy</a> uses an `int` field in the database, which puts an
+The <DocsLink href="/reference/typescript-api/money/default-money-strategy#defaultmoneystrategy">DefaultMoneyStrategy</DocsLink> uses an `int` field in the database, which puts an
 effective limit of ~21.4 million on any stored value. For certain use cases
 (e.g. business sales with very high amounts, or currencies with very large
 denominations), this may cause issues. In this case, you can use the
-<a href='/reference/typescript-api/money/big-int-money-strategy#bigintmoneystrategy'>BigIntMoneyStrategy</a> which will use the `bigint` type to store monetary values,
+<DocsLink href="/reference/typescript-api/money/big-int-money-strategy#bigintmoneystrategy">BigIntMoneyStrategy</DocsLink> which will use the `bigint` type to store monetary values,
 giving an effective upper limit of over 9 quadrillion.
 
 ## Precision
@@ -98,7 +94,7 @@ UI as to how many decimal places to display.
 <MemberInfo kind="method" type={`(value: number, quantity?: number) => number`}   />
 
 Defines the logic used to round monetary values. For instance, the default behavior
-in the <a href='/reference/typescript-api/money/default-money-strategy#defaultmoneystrategy'>DefaultMoneyStrategy</a> is to round the value, then multiply.
+in the <DocsLink href="/reference/typescript-api/money/default-money-strategy#defaultmoneystrategy">DefaultMoneyStrategy</DocsLink> is to round the value, then multiply.
 
 ```ts
 return Math.round(value * quantity);