npm - @vendure/docs - Versions diffs - 0.0.0-202601211609 → 0.0.0-202601221206 - Mend

@vendure/docs 0.0.0-202601211609 → 0.0.0-202601221206

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (381) hide show

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

@@ -52,7 +52,7 @@ class InMemoryJobQueueStrategy extends PollingJobQueueStrategy implements Inspec
 ### unsettledJobs
-<MemberInfo kind="property" type={``{ [queueName: string]: Array<{ job: `<a href='/reference/typescript-api/job-queue/job#job'>Job</a>`; updatedAt: Date }> }``}   />
+<MemberInfo kind="property" type={`{ [queueName: string]: Array<{ job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>; updatedAt: Date }> }`}   />
 ### init
@@ -67,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>`<Data>`) => `Promise<`<a href='/reference/typescript-api/job-queue/job#job'>Job</a>`<Data>>``}   />
+<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<`<a href='/reference/typescript-api/job-queue/job#job'>Job</a>` | undefined>``}   />
+<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<`<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<`<a href='/reference/typescript-api/job-queue/job#job'>Job</a>`>>``}   />
+<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<`<a href='/reference/typescript-api/job-queue/job#job'>Job</a>`[]>``}   />
+<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<`<a href='/reference/typescript-api/job-queue/job#job'>Job</a>` | undefined>``}   />
+<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<void>``}   />
+<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<number>``}   />
+<MemberInfo kind="method" type={`(queueNames: string[] = [], olderThan?: Date) => Promise<number>`}   />

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

@@ -35,12 +35,12 @@ class JobQueue<Data extends JobData<Data> = object> {
 ### constructor
-<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`}   />
+<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<Data>`) => `Promise<`<a href='/reference/typescript-api/job-queue/subscribable-job#subscribablejob'>SubscribableJob</a>`<Data>>``}   />
+<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 <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:

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

@@ -23,22 +23,22 @@ interface InspectableJobQueueStrategy extends JobQueueStrategy {
 ### findOne
-<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>``}   />
+<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<`<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<`<a href='/reference/typescript-api/job-queue/job#job'>Job</a>`>>``}   />
+<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<`<a href='/reference/typescript-api/job-queue/job#job'>Job</a>`[]>``}   />
+<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<number>``}   />
+<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
@@ -47,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<`<a href='/reference/typescript-api/job-queue/job#job'>Job</a>` | undefined>``}   />
+<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 CHANGED Viewed

@@ -29,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<`<a href='/reference/typescript-api/job-queue/job#job'>Job</a>`>``}   />
+<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<{ [bufferId: string]: number }>``}   />
+<MemberInfo kind="method" type={`(bufferIds?: string[]) => Promise<{ [bufferId: string]: number }>`}   />
 Returns an object containing the number of buffered jobs arranged by bufferId.
@@ -52,7 +52,7 @@ const sizes = await myJobBufferStrategy.bufferSize(['buffer-1', 'buffer-2']);
 ```
 ### flush
-<MemberInfo kind="method" type={`(bufferIds?: string[]) => `Promise<{ [bufferId: string]: `<a href='/reference/typescript-api/job-queue/job#job'>Job</a>`[] }>``}   />
+<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 CHANGED Viewed

@@ -97,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>`<Data>`) => `boolean | Promise<boolean>``}   />
+<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<`<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>>>``}   />
+<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-service.mdx CHANGED Viewed

@@ -61,29 +61,29 @@ class JobQueueService implements OnModuleDestroy {
 ### createQueue
-<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>>``}   />
+<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 <DocsLink href="/reference/typescript-api/job-queue/#jobqueue">JobQueue</DocsLink> instance.
 ### start
-<MemberInfo kind="method" type={`() => `Promise<void>``}   />
+<MemberInfo kind="method" type={`() => Promise<void>`}   />
 ### addBuffer
-<MemberInfo kind="method" type={`(buffer: <a href='/reference/typescript-api/job-queue/job-buffer#jobbuffer'>JobBuffer</a>`<any>`) => `}  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 <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>`<any>`) => `}  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 <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<`<a href='/reference/typescript-api/job-queue/job-buffer#jobbuffer'>JobBuffer</a>`<any> | string>`) => `Promise<{ [bufferId: string]: number }>``}  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.
@@ -100,7 +100,7 @@ const sizes = await this.jobQueueService.bufferSize('buffer-1', 'buffer-2');
 ```
 ### flush
-<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"  />
+<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,

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

@@ -36,17 +36,17 @@ interface JobQueueStrategy extends InjectableStrategy {
 ### add
-<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>>``}   />
+<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>`<Data>) => Promise<any>`) => `Promise<void>``}   />
+<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>`<Data>) => Promise<any>`) => `Promise<void>``}   />
+<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 CHANGED Viewed

@@ -117,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>`<T>`) => Job`}   />
+<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/job-queue/types#jobconfig'>JobConfig</a><T>) => Job`}   />
 ### start
@@ -155,12 +155,12 @@ 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>`<T>`) => `}   />
+<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>`<T>`) => `}   />
+<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>) => `}   />

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

@@ -42,12 +42,12 @@ class PollingJobQueueStrategy extends InjectableJobQueueStrategy {
 ### pollInterval
-<MemberInfo kind="property" type={``number | ((queueName: string) => 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>`) => number``}   />
+<MemberInfo kind="property" type={`(queueName: string, job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>) => number`}   />
 ### backOffStrategy
@@ -82,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>`<Data>) => Promise<any>`) => `}   />
+<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>`<Data>) => Promise<any>`) => `}   />
+<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<`<a href='/reference/typescript-api/job-queue/job#job'>Job</a>` | undefined>``}   />
+<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<`<a href='/reference/typescript-api/job-queue/job#job'>Job</a>` | undefined>``}   />
+<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<void>``}   />
+<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<`<a href='/reference/typescript-api/job-queue/job#job'>Job</a>` | undefined>``}   />
+<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 CHANGED Viewed

@@ -41,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>`<Data>`, jobOptions?: `JobQueueStrategyJobOptions<Data>`) => `Promise<`<a href='/reference/typescript-api/job-queue/job#job'>Job</a>`<Data>>``}   />
+<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<`<a href='/reference/typescript-api/job-queue/job#job'>Job</a>` | undefined>``}   />
+<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>`<any>`) => `Promise<void>``}   />
+<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<`<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<`<a href='/reference/typescript-api/job-queue/job#job'>Job</a>`>>``}   />
+<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<`<a href='/reference/typescript-api/job-queue/job#job'>Job</a>` | undefined>``}   />
+<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<`<a href='/reference/typescript-api/job-queue/job#job'>Job</a>`[]>``}   />
+<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 CHANGED Viewed

@@ -23,12 +23,12 @@ 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>`<T>`, 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<`<a href='/reference/typescript-api/job-queue/types#jobupdate'>JobUpdate</a>`<T>>``}   />
+<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.

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

@@ -72,7 +72,7 @@ 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>`<T>) => Promise<any>``}   />
+<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.

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

@@ -15,7 +15,7 @@ Parameters
 ### userConfig
-<MemberInfo kind="parameter" type={``Partial<`<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>`>``} />
+<MemberInfo kind="parameter" type={`Partial<<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>>`} />
 ### options

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

@@ -14,5 +14,5 @@ Parameters
 ### userConfig
-<MemberInfo kind="parameter" type={``Partial<`<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>`>``} />
+<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 CHANGED Viewed

@@ -14,5 +14,5 @@ Parameters
 ### userConfig
-<MemberInfo kind="parameter" type={``Partial<`<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>`>``} />
+<MemberInfo kind="parameter" type={`Partial<<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>>`} />

package/docs/reference/typescript-api/orders/active-order-service.mdx CHANGED Viewed

@@ -27,7 +27,7 @@ class ActiveOrderService {
 ### getOrderFromContext
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => `Promise<`<a href='/reference/typescript-api/entities/order#order'>Order</a>` | undefined>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a> | undefined>`}   />
 Gets the active Order object from the current Session. Optionally can create a new Order if
 no active Order exists.
@@ -36,27 +36,27 @@ Intended to be used at the Resolver layer for those resolvers that depend upon a
 being present.
 ### getOrderFromContext
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, createIfNotExists: true) => `Promise<`<a href='/reference/typescript-api/entities/order#order'>Order</a>`>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, createIfNotExists: true) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a>>`}   />
 ### getOrderFromContext
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, createIfNotExists:  = false) => `Promise<`<a href='/reference/typescript-api/entities/order#order'>Order</a>` | undefined>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, createIfNotExists:  = false) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a> | undefined>`}   />
 ### getActiveOrder
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: { [strategyName: string]: any } | undefined) => `Promise<`<a href='/reference/typescript-api/entities/order#order'>Order</a>` | undefined>``}  since="1.9.0"  />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: { [strategyName: string]: any } | undefined) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a> | undefined>`}  since="1.9.0"  />
 Retrieves the active Order based on the configured <DocsLink href="/reference/typescript-api/orders/active-order-strategy#activeorderstrategy">ActiveOrderStrategy</DocsLink>.
 ### getActiveOrder
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: { [strategyName: string]: any } | undefined, createIfNotExists: true) => `Promise<`<a href='/reference/typescript-api/entities/order#order'>Order</a>`>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: { [strategyName: string]: any } | undefined, createIfNotExists: true) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a>>`}   />
 ### getActiveOrder
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: `{ [strategyName: string]: Record<string, any> | undefined } | undefined`, createIfNotExists:  = false) => `Promise<`<a href='/reference/typescript-api/entities/order#order'>Order</a>` | undefined>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: { [strategyName: string]: Record<string, any> | undefined } | undefined, createIfNotExists:  = false) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a> | undefined>`}   />

package/docs/reference/typescript-api/orders/active-order-strategy.mdx CHANGED Viewed

@@ -141,7 +141,7 @@ The name of the strategy, e.g. "orderByToken", which will also be used as the
 field name in the ActiveOrderInput type.
 ### defineInputType
-<MemberInfo kind="property" type={``() => DocumentNode``}   />
+<MemberInfo kind="property" type={`() => DocumentNode`}   />
 Defines the type of the GraphQL Input object expected by the `activeOrderInput`
 input argument.
@@ -177,7 +177,7 @@ activeOrder(activeOrderInput: {
 the _first_ input will be assumed to be the top-level input.
 ### createActiveOrder
-<MemberInfo kind="property" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>`, input: InputType) => Promise<`<a href='/reference/typescript-api/entities/order#order'>Order</a>`>``}   />
+<MemberInfo kind="property" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: InputType) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a>>`}   />
 Certain mutations such as `addItemToOrder` can automatically create a new Order if one does not exist.
 In these cases, this method will be called to create the new Order.
@@ -186,7 +186,7 @@ If automatic creation of an Order does not make sense in your strategy, then lea
 undefined. You'll then need to take care of creating an order manually by defining a custom mutation.
 ### determineActiveOrder
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: InputType) => `Promise<`<a href='/reference/typescript-api/entities/order#order'>Order</a>` | undefined>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: InputType) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a> | undefined>`}   />
 This method is used to determine the active Order based on the current RequestContext in addition to any
 input values provided, as defined by the `defineInputType` method of this strategy.

package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx CHANGED Viewed

@@ -35,7 +35,7 @@ interface ChangedPriceHandlingStrategy extends InjectableStrategy {
 ### handlePriceChange
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, current: <a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>, orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => <a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>` | Promise<`<a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>`>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, current: <a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>, orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => <a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a> | Promise<<a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>>`}   />
 This method is called when adding to or adjusting OrderLines, if the latest price
 (as determined by the ProductVariant price, potentially modified by the configured

package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx CHANGED Viewed

@@ -48,7 +48,7 @@ class DefaultGuestCheckoutStrategy implements GuestCheckoutStrategy {
 ### setCustomerForOrder
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, input: CreateCustomerInput) => `Promise<`<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>`<SetCustomerForOrderResult, `<a href='/reference/typescript-api/entities/customer#customer'>Customer</a>`>>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, input: CreateCustomerInput) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><SetCustomerForOrderResult, <a href='/reference/typescript-api/entities/customer#customer'>Customer</a>>>`}   />

package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx CHANGED Viewed

@@ -20,7 +20,7 @@ class DefaultOrderItemPriceCalculationStrategy implements OrderItemPriceCalculat
 ### calculateUnitPrice
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariant: <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>) => <a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>` | Promise<`<a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>`>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariant: <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>) => <a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a> | Promise<<a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>>`}   />

package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx CHANGED Viewed

@@ -20,7 +20,7 @@ class DefaultStockAllocationStrategy implements StockAllocationStrategy {
 ### shouldAllocateStock
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, fromState: <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, toState: <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => `boolean | Promise<boolean>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, fromState: <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, toState: <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => boolean | Promise<boolean>`}   />

package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx CHANGED Viewed

@@ -42,7 +42,7 @@ interface GuestCheckoutStrategy extends InjectableStrategy {
 ### setCustomerForOrder
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, input: CreateCustomerInput) => | <a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>`<SetCustomerForOrderResult, `<a href='/reference/typescript-api/entities/customer#customer'>Customer</a>`>         | Promise<`<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>`<SetCustomerForOrderResult, `<a href='/reference/typescript-api/entities/customer#customer'>Customer</a>`>>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, input: CreateCustomerInput) => | <a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><SetCustomerForOrderResult, <a href='/reference/typescript-api/entities/customer#customer'>Customer</a>>         | Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><SetCustomerForOrderResult, <a href='/reference/typescript-api/entities/customer#customer'>Customer</a>>>`}   />
 This method is called when the `setCustomerForOrder` mutation is executed.
 It should return either a Customer object or an ErrorResult.

package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx CHANGED Viewed

@@ -43,7 +43,7 @@ interface OrderByCodeAccessStrategy extends InjectableStrategy {
 ### canAccessOrder
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => `boolean | Promise<boolean>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => boolean | Promise<boolean>`}   />
 Gives or denies permission to access the requested Order

package/docs/reference/typescript-api/orders/order-code-strategy.mdx CHANGED Viewed

@@ -47,7 +47,7 @@ interface OrderCodeStrategy extends InjectableStrategy {
 ### generate
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => `string | Promise<string>``}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => string | Promise<string>`}   />
 Generates the order code.