@vendure/docs 0.0.0-202601201808 → 0.0.0-202601211028

package/docs/reference/typescript-api/import-export/importer.mdx

@@ -2,16 +2,12 @@
 title: "Importer"
 generated: true
 ---
-
-
-## Importer
-
 <GenerationInfo sourceFile="packages/core/src/data-import/providers/importer/importer.ts" sourceLine="42" packageName="@vendure/core" />
 
 Parses and imports Products using the CSV import format.
 
-Internally it is using the <a href='/reference/typescript-api/import-export/import-parser#importparser'>ImportParser</a> to parse the CSV file, and then the
-<a href='/reference/typescript-api/import-export/fast-importer-service#fastimporterservice'>FastImporterService</a> and the <a href='/reference/typescript-api/import-export/asset-importer#assetimporter'>AssetImporter</a> to actually create the resulting
+Internally it is using the <DocsLink href="/reference/typescript-api/import-export/import-parser#importparser">ImportParser</DocsLink> to parse the CSV file, and then the
+<DocsLink href="/reference/typescript-api/import-export/fast-importer-service#fastimporterservice">FastImporterService</DocsLink> and the <DocsLink href="/reference/typescript-api/import-export/asset-importer#assetimporter">AssetImporter</DocsLink> to actually create the resulting
 entities in the Vendure database.
 
 ```ts title="Signature"
@@ -27,7 +23,7 @@ class Importer {
 
 ### parseAndImport
 
-<MemberInfo kind="method" type={`(input: string | Stream, ctxOrLanguageCode: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>, reportProgress: boolean = false) => Observable&#60;ImportProgress&#62;`}   />
+<MemberInfo kind="method" type={`(input: string | Stream, ctxOrLanguageCode: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>, reportProgress: boolean = false) => Observable<ImportProgress>`}   />
 
 Parses the contents of the [product import CSV file](/guides/developer-guide/importing-data/#product-import-format) and imports
 the resulting Product & ProductVariants, as well as any associated Assets, Facets & FacetValues.
@@ -35,12 +31,12 @@ the resulting Product & ProductVariants, as well as any associated Assets, Facet
 The `ctxOrLanguageCode` argument is used to specify the languageCode to be used when creating the Products.
 ### importProducts
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, rows: <a href='/reference/typescript-api/import-export/import-parser#parsedproductwithvariants'>ParsedProductWithVariants</a>[], onProgress: OnProgressFn) => Promise&#60;string[]&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, rows: <a href='/reference/typescript-api/import-export/import-parser#parsedproductwithvariants'>ParsedProductWithVariants</a>[], onProgress: OnProgressFn) => Promise<string[]>`}   />
 
 Imports the products specified in the rows object. Return an array of error messages.
 ### getFacetValueIds
 
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, facets: <a href='/reference/typescript-api/import-export/import-parser#parsedfacet'>ParsedFacet</a>[], languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>) => Promise&#60;<a href='/reference/typescript-api/common/id#id'>ID</a>[]&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, facets: <a href='/reference/typescript-api/import-export/import-parser#parsedfacet'>ParsedFacet</a>[], languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>) => Promise<<a href='/reference/typescript-api/common/id#id'>ID</a>[]>`}   />
 
 
 ### processCustomFieldValues

package/docs/reference/typescript-api/import-export/initial-data.mdx

@@ -2,10 +2,6 @@
 title: "InitialData"
 generated: true
 ---
-
-
-## InitialData
-
 <GenerationInfo sourceFile="packages/core/src/data-import/types.ts" sourceLine="47" packageName="@vendure/core" />
 
 An object defining initial settings for a new Vendure installation.
@@ -47,17 +43,17 @@ interface InitialData {
 
 ### taxRates
 
-<MemberInfo kind="property" type={`Array&#60;{ name: string; percentage: number }&#62;`}   />
+<MemberInfo kind="property" type={`Array<{ name: string; percentage: number }>`}   />
 
 
 ### shippingMethods
 
-<MemberInfo kind="property" type={`Array&#60;{ name: string; price: number; taxRate?: number }&#62;`}   />
+<MemberInfo kind="property" type={`Array<{ name: string; price: number; taxRate?: number }>`}   />
 
 
 ### paymentMethods
 
-<MemberInfo kind="property" type={`Array&#60;{ name: string; handler: ConfigurableOperationInput }&#62;`}   />
+<MemberInfo kind="property" type={`Array<{ name: string; handler: ConfigurableOperationInput }>`}   />
 
 
 ### collections

package/docs/reference/typescript-api/import-export/populate.mdx

@@ -2,10 +2,6 @@
 title: "Populate"
 generated: true
 ---
-
-
-## populate
-
 <GenerationInfo sourceFile="packages/core/src/cli/populate.ts" sourceLine="51" packageName="@vendure/core" />
 
 Populates the Vendure server with some initial data and (optionally) product data from
@@ -18,9 +14,9 @@ The argument can be either a Channel object or a valid channel `token`.
 
 Internally the `populate()` function does the following:
 
-1. Uses the <a href='/reference/typescript-api/import-export/populator#populator'>Populator</a> to populate the <a href='/reference/typescript-api/import-export/initial-data#initialdata'>InitialData</a>.
-2. If `productsCsvPath` is provided, uses <a href='/reference/typescript-api/import-export/importer#importer'>Importer</a> to populate Product data.
-3. Uses <a href='/reference/typescript-api/import-export/populator#populator'>Populator</a> to populate collections specified in the <a href='/reference/typescript-api/import-export/initial-data#initialdata'>InitialData</a>.
+1. Uses the <DocsLink href="/reference/typescript-api/import-export/populator#populator">Populator</DocsLink> to populate the <DocsLink href="/reference/typescript-api/import-export/initial-data#initialdata">InitialData</DocsLink>.
+2. If `productsCsvPath` is provided, uses <DocsLink href="/reference/typescript-api/import-export/importer#importer">Importer</DocsLink> to populate Product data.
+3. Uses <DocsLink href="/reference/typescript-api/import-export/populator#populator">Populator</DocsLink> to populate collections specified in the <DocsLink href="/reference/typescript-api/import-export/initial-data#initialdata">InitialData</DocsLink>.
 
 *Example*
 
@@ -54,7 +50,7 @@ Parameters
 
 ### bootstrapFn
 
-<MemberInfo kind="parameter" type={`() =&#62; Promise&#60;T | undefined&#62;`} />
+<MemberInfo kind="parameter" type={`() => Promise<T | undefined>`} />
 
 ### initialDataPathOrObject
 

package/docs/reference/typescript-api/import-export/populator.mdx

@@ -2,13 +2,9 @@
 title: "Populator"
 generated: true
 ---
-
-
-## Populator
-
 <GenerationInfo sourceFile="packages/core/src/data-import/providers/populator/populator.ts" sourceLine="46" packageName="@vendure/core" />
 
-Responsible for populating the database with <a href='/reference/typescript-api/import-export/initial-data#initialdata'>InitialData</a>, i.e. non-product data such as countries, tax rates,
+Responsible for populating the database with <DocsLink href="/reference/typescript-api/import-export/initial-data#initialdata">InitialData</DocsLink>, i.e. non-product data such as countries, tax rates,
 shipping methods, payment methods & roles.
 
 ```ts title="Signature"
@@ -25,7 +21,7 @@ class Populator {
 <MemberInfo kind="method" type={`(data: <a href='/reference/typescript-api/import-export/initial-data#initialdata'>InitialData</a>, channel?: <a href='/reference/typescript-api/entities/channel#channel'>Channel</a>) => `}   />
 
 Should be run *before* populating the products, so that there are TaxRates by which
-product prices can be set. If the `channel` argument is set, then any <a href='/reference/typescript-api/entities/interfaces#channelaware'>ChannelAware</a>entities will be assigned to that Channel.
+product prices can be set. If the `channel` argument is set, then any <DocsLink href="/reference/typescript-api/entities/interfaces#channelaware">ChannelAware</DocsLink>entities will be assigned to that Channel.
 ### populateCollections
 
 <MemberInfo kind="method" type={`(data: <a href='/reference/typescript-api/import-export/initial-data#initialdata'>InitialData</a>, channel?: <a href='/reference/typescript-api/entities/channel#channel'>Channel</a>) => `}   />

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

@@ -2,13 +2,9 @@
 title: "DefaultJobQueuePlugin"
 generated: true
 ---
-
-
-## DefaultJobQueuePlugin
-
 <GenerationInfo sourceFile="packages/core/src/plugin/default-job-queue-plugin/default-job-queue-plugin.ts" sourceLine="127" packageName="@vendure/core" />
 
-A plugin which configures Vendure to use the SQL database to persist the JobQueue jobs using the <a href='/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy'>SqlJobQueueStrategy</a>. If you add this
+A plugin which configures Vendure to use the SQL database to persist the JobQueue jobs using the <DocsLink href="/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy">SqlJobQueueStrategy</DocsLink>. If you add this
 plugin to an existing Vendure installation, you'll need to run a [database migration](/guides/developer-guide/migrations), since this
 plugin will add a new "job_record" table to the database.
 
@@ -27,7 +23,7 @@ export const config: VendureConfig = {
 
 ## Configuration
 
-It is possible to configure the behaviour of the <a href='/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy'>SqlJobQueueStrategy</a> by passing options to the static `init()` function:
+It is possible to configure the behaviour of the <DocsLink href="/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy">SqlJobQueueStrategy</DocsLink> by passing options to the static `init()` function:
 
 ### pollInterval
 The interval in ms between polling for new jobs. The default is 200ms.
@@ -129,29 +125,21 @@ class DefaultJobQueuePlugin {
 
 ### init
 
-<MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueoptions'>DefaultJobQueueOptions</a>) => Type&#60;<a href='/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin'>DefaultJobQueuePlugin</a>&#62;`}   />
+<MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueoptions'>DefaultJobQueueOptions</a>) => Type<<a href='/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin'>DefaultJobQueuePlugin</a>>`}   />
 
 
 
 
 </div>
-
-
-## cleanJobsTask
-
 <GenerationInfo sourceFile="packages/core/src/plugin/default-job-queue-plugin/clean-jobs-task.ts" sourceLine="18" packageName="@vendure/core" since="3.3.0" />
 
-A <a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtask'>ScheduledTask</a> that cleans up old jobs from the database when using the DefaultJobQueuePlugin.
-You can configure the settings & schedule of the task via the <a href='/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin'>DefaultJobQueuePlugin</a> options.
-
-
-
-## DefaultJobQueueOptions
+A <DocsLink href="/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtask">ScheduledTask</DocsLink> that cleans up old jobs from the database when using the DefaultJobQueuePlugin.
+You can configure the settings & schedule of the task via the <DocsLink href="/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin">DefaultJobQueuePlugin</DocsLink> options.
 
 <GenerationInfo sourceFile="packages/core/src/plugin/default-job-queue-plugin/types.ts" sourceLine="12" packageName="@vendure/core" />
 
 Configuration options for the DefaultJobQueuePlugin. These values get passed into the
-<a href='/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy'>SqlJobQueueStrategy</a>.
+<DocsLink href="/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy">SqlJobQueueStrategy</DocsLink>.
 
 ```ts title="Signature"
 interface DefaultJobQueueOptions {
@@ -170,7 +158,7 @@ interface DefaultJobQueueOptions {
 
 ### pollInterval
 
-<MemberInfo kind="property" type={`number | ((queueName: string) =&#62; number)`} default={`200`}   />
+<MemberInfo kind="property" type={`number | ((queueName: string) => number)`} default={`200`}   />
 
 The interval in ms between polling the database for new jobs. If many job queues
 are active, the polling may cause undue load on the database, in which case this value
@@ -182,12 +170,12 @@ should be increased to e.g. 1000.
 How many jobs from a given queue to process concurrently.
 ### backoffStrategy
 
-<MemberInfo kind="property" type={`<a href='/reference/typescript-api/job-queue/types#backoffstrategy'>BackoffStrategy</a>`} default={`() =&#62; 1000`}   />
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/job-queue/types#backoffstrategy'>BackoffStrategy</a>`} default={`() => 1000`}   />
 
 The strategy used to decide how long to wait before retrying a failed job.
 ### 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`}   />
 
 When a job is added to the JobQueue using `JobQueue.add()`, the calling
 code may specify the number of retries in case of failure. This option allows
@@ -234,7 +222,7 @@ debugging and auditing purposes, but if you have a lot of jobs, it may be
 desirable to limit the number of records in the database.
 ### cleanJobsSchedule
 
-<MemberInfo kind="property" type={`<a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtaskconfig'>ScheduledTaskConfig</a>['schedule']`} default={`cron =&#62; cron.every(2).hours()`}  since="3.3.0"  />
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtaskconfig'>ScheduledTaskConfig</a>['schedule']`} default={`cron => cron.every(2).hours()`}  since="3.3.0"  />
 
 The schedule for the "clean-jobs" task. This task will run periodically to clean up
 old jobs from the database. The schedule can be a cron expression or a function

package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx

@@ -2,18 +2,14 @@
 title: "InMemoryJobBufferStorageStrategy"
 generated: true
 ---
-
-
-## InMemoryJobBufferStorageStrategy
-
 <GenerationInfo sourceFile="packages/core/src/job-queue/job-buffer/in-memory-job-buffer-storage-strategy.ts" sourceLine="17" packageName="@vendure/core" since="1.3.0" />
 
-A <a href='/reference/typescript-api/job-queue/job-buffer-storage-strategy#jobbufferstoragestrategy'>JobBufferStorageStrategy</a> which keeps the buffered jobs in memory. Should
+A <DocsLink href="/reference/typescript-api/job-queue/job-buffer-storage-strategy#jobbufferstoragestrategy">JobBufferStorageStrategy</DocsLink> which keeps the buffered jobs in memory. Should
 _not_ be used in production, since it will lose data in the event of the server
 stopping.
 
-Instead, use the <a href='/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin'>DefaultJobQueuePlugin</a> with the `useDatabaseForBuffer: true` option set,
-or the <a href='/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-plugin#bullmqjobqueueplugin'>BullMQJobQueuePlugin</a> or another custom strategy with persistent storage.
+Instead, use the <DocsLink href="/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin">DefaultJobQueuePlugin</DocsLink> with the `useDatabaseForBuffer: true` option set,
+or the <DocsLink href="/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-plugin#bullmqjobqueueplugin">BullMQJobQueuePlugin</DocsLink> or another custom strategy with persistent storage.
 
 ```ts title="Signature"
 class InMemoryJobBufferStorageStrategy implements JobBufferStorageStrategy {
@@ -36,17 +32,17 @@ class InMemoryJobBufferStorageStrategy implements JobBufferStorageStrategy {
 
 ### add
 
-<MemberInfo kind="method" type={`(bufferId: string, job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>) => Promise&#60;<a href='/reference/typescript-api/job-queue/job#job'>Job</a>&#62;`}   />
+<MemberInfo kind="method" type={`(bufferId: string, job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>) => Promise<<a href='/reference/typescript-api/job-queue/job#job'>Job</a>>`}   />
 
 
 ### bufferSize
 
-<MemberInfo kind="method" type={`(bufferIds?: string[]) => Promise&#60;{ [bufferId: string]: number }&#62;`}   />
+<MemberInfo kind="method" type={`(bufferIds?: string[]) => Promise<{ [bufferId: string]: number }>`}   />
 
 
 ### flush
 
-<MemberInfo kind="method" type={`(bufferIds?: string[]) => Promise&#60;{ [bufferId: string]: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>[] }&#62;`}   />
+<MemberInfo kind="method" type={`(bufferIds?: string[]) => Promise<{ [bufferId: string]: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>[] }>`}   />
 
 
 

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

@@ -2,14 +2,10 @@
 title: "InMemoryJobQueueStrategy"
 generated: true
 ---
-
-
-## InMemoryJobQueueStrategy
-
 <GenerationInfo sourceFile="packages/core/src/job-queue/in-memory-job-queue-strategy.ts" sourceLine="42" packageName="@vendure/core" />
 
-An in-memory <a href='/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy'>JobQueueStrategy</a>. This is the default strategy if not using a dedicated
-JobQueue plugin (e.g. <a href='/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin'>DefaultJobQueuePlugin</a>). Not recommended for production, since
+An in-memory <DocsLink href="/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy">JobQueueStrategy</DocsLink>. This is the default strategy if not using a dedicated
+JobQueue plugin (e.g. <DocsLink href="/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin">DefaultJobQueuePlugin</DocsLink>). Not recommended for production, since
 the queue will be cleared when the server stops, and can only be used when the JobQueueService is
 started from the main server process:
 
@@ -56,7 +52,7 @@ class InMemoryJobQueueStrategy extends PollingJobQueueStrategy implements Inspec
 
 ### unsettledJobs
 
-<MemberInfo kind="property" type={`{ [queueName: string]: Array&#60;{ job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>; updatedAt: Date }&#62; }`}   />
+<MemberInfo kind="property" type={`{ [queueName: string]: Array<{ job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>; updatedAt: Date }> }`}   />
 
 
 ### init
@@ -71,37 +67,37 @@ class InMemoryJobQueueStrategy extends PollingJobQueueStrategy implements Inspec
 
 ### add
 
-<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>&#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>) => Promise<<a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>>`}   />
 
 
 ### 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>`}   />
 
 
 ### 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>>>`}   />
 
 
 ### 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>[]>`}   />
 
 
 ### next
 
-<MemberInfo kind="method" type={`(queueName: string, waitingJobs: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>[] = []) => Promise&#60;<a href='/reference/typescript-api/job-queue/job#job'>Job</a> | undefined&#62;`}   />
+<MemberInfo kind="method" type={`(queueName: string, waitingJobs: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>[] = []) => 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>) => Promise&#60;void&#62;`}   />
+<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>) => Promise<void>`}   />
 
 
 ### removeSettledJobs
 
-<MemberInfo kind="method" type={`(queueNames: string[] = [], olderThan?: Date) => Promise&#60;number&#62;`}   />
+<MemberInfo kind="method" type={`(queueNames: string[] = [], olderThan?: Date) => Promise<number>`}   />
 
 
 

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

@@ -2,18 +2,14 @@
 title: "JobQueue"
 generated: true
 ---
-
-
-## JobQueue
-
 <GenerationInfo sourceFile="packages/core/src/job-queue/job-queue.ts" sourceLine="21" packageName="@vendure/core" />
 
-A JobQueue is used to process <a href='/reference/typescript-api/job-queue/job#job'>Job</a>s. A job is added to the queue via the
-`.add()` method, and the configured <a href='/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy'>JobQueueStrategy</a> will check for new jobs and process each
+A JobQueue is used to process <DocsLink href="/reference/typescript-api/job-queue/job#job">Job</DocsLink>s. A job is added to the queue via the
+`.add()` method, and the configured <DocsLink href="/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy">JobQueueStrategy</DocsLink> will check for new jobs and process each
 according to the defined `process` function.
 
 *Note*: JobQueue instances should not be directly instantiated. Rather, the
-<a href='/reference/typescript-api/job-queue/job-queue-service#jobqueueservice'>JobQueueService</a> `createQueue()` method should be used (see that service
+<DocsLink href="/reference/typescript-api/job-queue/job-queue-service#jobqueueservice">JobQueueService</DocsLink> `createQueue()` method should be used (see that service
 for example usage).
 
 ```ts title="Signature"
@@ -39,14 +35,14 @@ class JobQueue<Data extends JobData<Data> = object> {
 
 ### constructor
 
-<MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/job-queue/types#createqueueoptions'>CreateQueueOptions</a>&#60;Data&#62;, jobQueueStrategy: <a href='/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy'>JobQueueStrategy</a>, jobBufferService: JobBufferService) => JobQueue`}   />
+<MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/job-queue/types#createqueueoptions'>CreateQueueOptions</a><Data>, jobQueueStrategy: <a href='/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy'>JobQueueStrategy</a>, jobBufferService: JobBufferService) => JobQueue`}   />
 
 
 ### add
 
-<MemberInfo kind="method" type={`(data: Data, options?: JobOptions&#60;Data&#62;) => Promise&#60;<a href='/reference/typescript-api/job-queue/subscribable-job#subscribablejob'>SubscribableJob</a>&#60;Data&#62;&#62;`}   />
+<MemberInfo kind="method" type={`(data: Data, options?: JobOptions<Data>) => Promise<<a href='/reference/typescript-api/job-queue/subscribable-job#subscribablejob'>SubscribableJob</a><Data>>`}   />
 
-Adds a new <a href='/reference/typescript-api/job-queue/job#job'>Job</a> to the queue. The resolved <a href='/reference/typescript-api/job-queue/subscribable-job#subscribablejob'>SubscribableJob</a> allows the
+Adds a new <DocsLink href="/reference/typescript-api/job-queue/job#job">Job</DocsLink> to the queue. The resolved <DocsLink href="/reference/typescript-api/job-queue/subscribable-job#subscribablejob">SubscribableJob</DocsLink> allows the
 calling code to subscribe to updates to the Job:
 
 *Example*

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

@@ -2,10 +2,6 @@
 title: "InspectableJobQueueStrategy"
 generated: true
 ---
-
-
-## InspectableJobQueueStrategy
-
 <GenerationInfo sourceFile="packages/core/src/config/job-queue/inspectable-job-queue-strategy.ts" sourceLine="14" packageName="@vendure/core" />
 
 Defines a job queue strategy that can be inspected using the default admin ui
@@ -27,22 +23,22 @@ interface InspectableJobQueueStrategy extends JobQueueStrategy {
 
 ### 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.
 ### 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>>>`}   />
 
 Returns a list of jobs according to the specified options.
 ### 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>[]>`}   />
 
 Returns an array of jobs for the given ids.
 ### removeSettledJobs
 
-<MemberInfo kind="method" type={`(queueNames?: string[], olderThan?: Date) => Promise&#60;number&#62;`}   />
+<MemberInfo kind="method" type={`(queueNames?: string[], olderThan?: Date) => Promise<number>`}   />
 
 Remove all settled jobs in the specified queues older than the given date.
 If no queueName is passed, all queues will be considered. If no olderThan
@@ -51,7 +47,7 @@ date is passed, all jobs older than the current time will be removed.
 Returns a promise of the number of jobs removed.
 ### 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>`}   />
 
 
 

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

@@ -2,14 +2,10 @@
 title: "JobBufferStorageStrategy"
 generated: true
 ---
-
-
-## JobBufferStorageStrategy
-
 <GenerationInfo sourceFile="packages/core/src/job-queue/job-buffer/job-buffer-storage-strategy.ts" sourceLine="19" packageName="@vendure/core" since="1.3.0" />
 
 This strategy defines where to store jobs that have been collected by a
-<a href='/reference/typescript-api/job-queue/job-buffer#jobbuffer'>JobBuffer</a>.
+<DocsLink href="/reference/typescript-api/job-queue/job-buffer#jobbuffer">JobBuffer</DocsLink>.
 
 :::info
 
@@ -33,14 +29,14 @@ interface JobBufferStorageStrategy extends InjectableStrategy {
 
 ### add
 
-<MemberInfo kind="method" type={`(bufferId: string, job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>) => Promise&#60;<a href='/reference/typescript-api/job-queue/job#job'>Job</a>&#62;`}   />
+<MemberInfo kind="method" type={`(bufferId: string, job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>) => Promise<<a href='/reference/typescript-api/job-queue/job#job'>Job</a>>`}   />
 
 Persist a job to the storage medium. The storage format should
 take into account the `bufferId` argument, as it is necessary to be
 able to later retrieve jobs by that id.
 ### bufferSize
 
-<MemberInfo kind="method" type={`(bufferIds?: string[]) => Promise&#60;{ [bufferId: string]: number }&#62;`}   />
+<MemberInfo kind="method" type={`(bufferIds?: string[]) => Promise<{ [bufferId: string]: number }>`}   />
 
 Returns an object containing the number of buffered jobs arranged by bufferId.
 
@@ -56,7 +52,7 @@ const sizes = await myJobBufferStrategy.bufferSize(['buffer-1', 'buffer-2']);
 ```
 ### flush
 
-<MemberInfo kind="method" type={`(bufferIds?: string[]) => Promise&#60;{ [bufferId: string]: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>[] }&#62;`}   />
+<MemberInfo kind="method" type={`(bufferIds?: string[]) => Promise<{ [bufferId: string]: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>[] }>`}   />
 
 Clears all jobs from the storage medium which match the specified bufferIds (if the
 array is empty, clear for _all_ bufferIds), and returns those jobs in an object

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

@@ -2,16 +2,12 @@
 title: "JobBuffer"
 generated: true
 ---
-
-
-## JobBuffer
-
 <GenerationInfo sourceFile="packages/core/src/job-queue/job-buffer/job-buffer.ts" sourceLine="83" packageName="@vendure/core" since="1.3.0" />
 
 A JobBuffer is used to temporarily prevent jobs from being sent to the job queue for processing.
 Instead, it collects certain jobs (as specified by the `collect()` method), and stores them.
 
-How these buffered jobs are stored is determined by the configured <a href='/reference/typescript-api/job-queue/job-buffer-storage-strategy#jobbufferstoragestrategy'>JobBufferStorageStrategy</a>.
+How these buffered jobs are stored is determined by the configured <DocsLink href="/reference/typescript-api/job-queue/job-buffer-storage-strategy#jobbufferstoragestrategy">JobBufferStorageStrategy</DocsLink>.
 
 The JobBuffer can be thought of as a kind of "interceptor" of jobs. That is, when a JobBuffer is active,
 it sits in between calls to `JobQueue.add()` and the actual adding of the job to the queue.
@@ -62,7 +58,7 @@ export class CollectionJobBuffer implements JobBuffer<ApplyCollectionFiltersJobD
 }
 ```
 
-A JobBuffer is used by adding it to the <a href='/reference/typescript-api/job-queue/job-queue-service#jobqueueservice'>JobQueueService</a>, at which point it will become active
+A JobBuffer is used by adding it to the <DocsLink href="/reference/typescript-api/job-queue/job-queue-service#jobqueueservice">JobQueueService</DocsLink>, at which point it will become active
 and start collecting jobs.
 
 At some later point, the buffer can be flushed, causing the buffered jobs to be passed through the
@@ -101,14 +97,14 @@ interface JobBuffer<Data extends JobData<Data> = object> {
 
 ### collect
 
-<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>&#60;Data&#62;) => boolean | Promise&#60;boolean&#62;`}   />
+<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>) => boolean | Promise<boolean>`}   />
 
 This method is called whenever a job is added to the job queue. If it returns `true`, then
 the job will be _buffered_ and _not_ added to the job queue. If it returns `false`, the job
 will be added to the job queue as normal.
 ### reduce
 
-<MemberInfo kind="method" type={`(collectedJobs: Array&#60;<a href='/reference/typescript-api/job-queue/job#job'>Job</a>&#60;Data&#62;&#62;) => Array&#60;<a href='/reference/typescript-api/job-queue/job#job'>Job</a>&#60;Data&#62;&#62; | Promise&#60;Array&#60;<a href='/reference/typescript-api/job-queue/job#job'>Job</a>&#60;Data&#62;&#62;&#62;`}   />
+<MemberInfo kind="method" type={`(collectedJobs: Array<<a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>>) => Array<<a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>> | Promise<Array<<a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>>>`}   />
 
 This method is called whenever the buffer gets flushed via a call to `JobQueueService.flush()`.
 It allows logic to be run on the buffered jobs which enables optimizations such as

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

@@ -2,10 +2,6 @@
 title: "JobQueueOptions"
 generated: true
 ---
-
-
-## JobQueueOptions
-
 <GenerationInfo sourceFile="packages/core/src/config/vendure-config.ts" sourceLine="960" packageName="@vendure/core" />
 
 Options related to the built-in job queue.

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

@@ -2,13 +2,9 @@
 title: "JobQueueService"
 generated: true
 ---
-
-
-## JobQueueService
-
 <GenerationInfo sourceFile="packages/core/src/job-queue/job-queue.service.ts" sourceLine="49" packageName="@vendure/core" />
 
-The JobQueueService is used to create new <a href='/reference/typescript-api/job-queue/#jobqueue'>JobQueue</a> instances and access
+The JobQueueService is used to create new <DocsLink href="/reference/typescript-api/job-queue/#jobqueue">JobQueue</DocsLink> instances and access
 existing jobs.
 
 *Example*
@@ -65,29 +61,29 @@ class JobQueueService implements OnModuleDestroy {
 
 ### createQueue
 
-<MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/job-queue/types#createqueueoptions'>CreateQueueOptions</a>&#60;Data&#62;) => Promise&#60;<a href='/reference/typescript-api/job-queue/#jobqueue'>JobQueue</a>&#60;Data&#62;&#62;`}   />
+<MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/job-queue/types#createqueueoptions'>CreateQueueOptions</a><Data>) => Promise<<a href='/reference/typescript-api/job-queue/#jobqueue'>JobQueue</a><Data>>`}   />
 
-Configures and creates a new <a href='/reference/typescript-api/job-queue/#jobqueue'>JobQueue</a> instance.
+Configures and creates a new <DocsLink href="/reference/typescript-api/job-queue/#jobqueue">JobQueue</DocsLink> instance.
 ### start
 
-<MemberInfo kind="method" type={`() => Promise&#60;void&#62;`}   />
+<MemberInfo kind="method" type={`() => Promise<void>`}   />
 
 
 ### addBuffer
 
-<MemberInfo kind="method" type={`(buffer: <a href='/reference/typescript-api/job-queue/job-buffer#jobbuffer'>JobBuffer</a>&#60;any&#62;) => `}  since="1.3.0"  />
+<MemberInfo kind="method" type={`(buffer: <a href='/reference/typescript-api/job-queue/job-buffer#jobbuffer'>JobBuffer</a><any>) => `}  since="1.3.0"  />
 
-Adds a <a href='/reference/typescript-api/job-queue/job-buffer#jobbuffer'>JobBuffer</a>, which will make it active and begin collecting
+Adds a <DocsLink href="/reference/typescript-api/job-queue/job-buffer#jobbuffer">JobBuffer</DocsLink>, which will make it active and begin collecting
 jobs to buffer.
 ### removeBuffer
 
-<MemberInfo kind="method" type={`(buffer: <a href='/reference/typescript-api/job-queue/job-buffer#jobbuffer'>JobBuffer</a>&#60;any&#62;) => `}  since="1.3.0"  />
+<MemberInfo kind="method" type={`(buffer: <a href='/reference/typescript-api/job-queue/job-buffer#jobbuffer'>JobBuffer</a><any>) => `}  since="1.3.0"  />
 
-Removes a <a href='/reference/typescript-api/job-queue/job-buffer#jobbuffer'>JobBuffer</a>, prevent it from collecting and buffering any
+Removes a <DocsLink href="/reference/typescript-api/job-queue/job-buffer#jobbuffer">JobBuffer</DocsLink>, prevent it from collecting and buffering any
 subsequent jobs.
 ### bufferSize
 
-<MemberInfo kind="method" type={`(forBuffers: Array&#60;<a href='/reference/typescript-api/job-queue/job-buffer#jobbuffer'>JobBuffer</a>&#60;any&#62; | string&#62;) => Promise&#60;{ [bufferId: string]: number }&#62;`}  since="1.3.0"  />
+<MemberInfo kind="method" type={`(forBuffers: Array<<a href='/reference/typescript-api/job-queue/job-buffer#jobbuffer'>JobBuffer</a><any> | string>) => Promise<{ [bufferId: string]: number }>`}  since="1.3.0"  />
 
 Returns an object containing the number of buffered jobs arranged by bufferId. This
 can be used to decide whether a particular buffer has any jobs to flush.
@@ -104,7 +100,7 @@ const sizes = await this.jobQueueService.bufferSize('buffer-1', 'buffer-2');
 ```
 ### flush
 
-<MemberInfo kind="method" type={`(forBuffers: Array&#60;<a href='/reference/typescript-api/job-queue/job-buffer#jobbuffer'>JobBuffer</a>&#60;any&#62; | string&#62;) => Promise&#60;<a href='/reference/typescript-api/job-queue/job#job'>Job</a>[]&#62;`}  since="1.3.0"  />
+<MemberInfo kind="method" type={`(forBuffers: Array<<a href='/reference/typescript-api/job-queue/job-buffer#jobbuffer'>JobBuffer</a><any> | string>) => Promise<<a href='/reference/typescript-api/job-queue/job#job'>Job</a>[]>`}  since="1.3.0"  />
 
 Flushes the specified buffers, which means that the buffer is cleared and the jobs get
 sent to the job queue for processing. Before sending the jobs to the job queue,