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

@vendure/docs 0.0.0-202601211552 → 0.0.0-202601211609

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

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

@@ -66,7 +66,7 @@ class EventBus implements OnModuleDestroy {
 ### publish
-<MemberInfo kind="method" type={`(event: T) => Promise<void>`}   />
+<MemberInfo kind="method" type={`(event: T) => `Promise<void>``}   />
 Publish an event which any subscribers can react to.
@@ -77,7 +77,7 @@ await eventBus.publish(new SomeEvent());
 ```
 ### ofType
-<MemberInfo kind="method" type={`(type: Type<T>) => Observable<T>`}   />
+<MemberInfo kind="method" type={`(type: `Type<T>`) => `Observable<T>``}   />
 Returns an RxJS Observable stream of events of the given type.
 If the event contains a <DocsLink href="/reference/typescript-api/request/request-context#requestcontext">RequestContext</DocsLink> object, the subscriber
@@ -87,7 +87,7 @@ This means that the subscriber function can safely access all updated
 data related to the event.
 ### filter
-<MemberInfo kind="method" type={`(predicate: (event: <a href='/reference/typescript-api/events/vendure-event#vendureevent'>VendureEvent</a>) => boolean) => Observable<T>`}   />
+<MemberInfo kind="method" type={`(predicate: (event: <a href='/reference/typescript-api/events/vendure-event#vendureevent'>VendureEvent</a>`) => boolean`) => `Observable<T>``}   />
 Returns an RxJS Observable stream of events filtered by a custom predicate.
 If the event contains a <DocsLink href="/reference/typescript-api/request/request-context#requestcontext">RequestContext</DocsLink> object, the subscriber

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

@@ -169,7 +169,7 @@ class ChangeChannelEvent<T extends ChannelAware & VendureEntity> extends Vendure
 ### constructor
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: T, channelIds: <a href='/reference/typescript-api/common/id#id'>ID</a>[], type: 'assigned' | 'removed', entityType?: Type<T>) => ChangeChannelEvent`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: T, channelIds: <a href='/reference/typescript-api/common/id#id'>ID</a>[], type: 'assigned' | 'removed', entityType?: `Type<T>`) => ChangeChannelEvent`}   />

package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx CHANGED Viewed

@@ -123,7 +123,7 @@ If an Error is thrown from within this function, no Fulfillment is created and t
 result will be returned.
 ### onFulfillmentTransition
-<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a>`<<a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>`FulfillmentState</a>, <a href='/reference/typescript-api/fulfillment/fulfillment-transition-data#fulfillmenttransitiondata'>FulfillmentTransitionData</a>>`}   />
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a>`<`<a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a>, <a href='/reference/typescript-api/fulfillment/fulfillment-transition-data#fulfillmenttransitiondata'>FulfillmentTransitionData</a>`>``}   />
 This allows the handler to intercept state transitions of the created Fulfillment. This works much in the
 same way as the <DocsLink href="/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess">FulfillmentProcess</DocsLink> `onTransitionStart` method (i.e. returning `false` or

package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx CHANGED Viewed

@@ -39,22 +39,22 @@ interface FulfillmentProcess<State extends keyof CustomFulfillmentStates | strin
 ### transitions
-<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<State, State | <a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>`FulfillmentState</a>> &#38;         Partial<<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<<a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>`FulfillmentState</a> | State>>`}   />
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<State, State | `<a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a>`> &#38;         Partial<`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<`<a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a>` | State>>``}   />
 ### onTransitionStart
-<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a>`<State | <a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>`FulfillmentState</a>, <a href='/reference/typescript-api/fulfillment/fulfillment-transition-data#fulfillmenttransitiondata'>FulfillmentTransitionData</a>>`}   />
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a>`<State | `<a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a>, <a href='/reference/typescript-api/fulfillment/fulfillment-transition-data#fulfillmenttransitiondata'>FulfillmentTransitionData</a>`>``}   />
 ### onTransitionEnd
-<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a>`<State | <a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>`FulfillmentState</a>, <a href='/reference/typescript-api/fulfillment/fulfillment-transition-data#fulfillmenttransitiondata'>FulfillmentTransitionData</a>>`}   />
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a>`<State | `<a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a>, <a href='/reference/typescript-api/fulfillment/fulfillment-transition-data#fulfillmenttransitiondata'>FulfillmentTransitionData</a>`>``}   />
 ### onTransitionError
-<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a>`<State | <a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>`FulfillmentState</a>>`}   />
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a>`<State | `<a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a>`>``}   />

package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx CHANGED Viewed

@@ -32,7 +32,7 @@ interface AssetImportStrategy extends InjectableStrategy {
 ### getStreamFromPath
-<MemberInfo kind="method" type={`(assetPath: string) => Readable | Promise<Readable>`}   />
+<MemberInfo kind="method" type={`(assetPath: string) => `Readable | Promise<Readable>``}   />
 Given an asset path, this method should return a Stream of file data. This could
 e.g. be read from a file system or fetch from a remote location.

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

@@ -18,7 +18,7 @@ class AssetImporter {
 ### getAssets
-<MemberInfo kind="method" type={`(assetPaths: string[], ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<{ assets: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[]; errors: string[] }>`}   />
+<MemberInfo kind="method" type={`(assetPaths: string[], ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => `Promise<{ assets: `<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>`[]; errors: string[] }>``}   />
 Creates Asset entities for the given paths, using the assetMap cache to prevent the
 creation of duplicates.

package/docs/reference/typescript-api/import-export/fast-importer-service.mdx CHANGED Viewed

@@ -34,17 +34,17 @@ Passing a `channel` argument means that Products and ProductVariants will be ass
 to that Channel.
 ### createProduct
-<MemberInfo kind="method" type={`(input: CreateProductInput) => Promise<<a href='/reference/typescript-api/common/id#id'>ID</a>>`}   />
+<MemberInfo kind="method" type={`(input: CreateProductInput) => `Promise<`<a href='/reference/typescript-api/common/id#id'>ID</a>`>``}   />
 ### createProductOptionGroup
-<MemberInfo kind="method" type={`(input: CreateProductOptionGroupInput) => Promise<<a href='/reference/typescript-api/common/id#id'>ID</a>>`}   />
+<MemberInfo kind="method" type={`(input: CreateProductOptionGroupInput) => `Promise<`<a href='/reference/typescript-api/common/id#id'>ID</a>`>``}   />
 ### createProductOption
-<MemberInfo kind="method" type={`(input: CreateProductOptionInput) => Promise<<a href='/reference/typescript-api/common/id#id'>ID</a>>`}   />
+<MemberInfo kind="method" type={`(input: CreateProductOptionInput) => `Promise<`<a href='/reference/typescript-api/common/id#id'>ID</a>`>``}   />
 ### addOptionGroupToProduct
@@ -54,7 +54,7 @@ to that Channel.
 ### createProductVariant
-<MemberInfo kind="method" type={`(input: CreateProductVariantInput) => Promise<<a href='/reference/typescript-api/common/id#id'>ID</a>>`}   />
+<MemberInfo kind="method" type={`(input: CreateProductVariantInput) => `Promise<`<a href='/reference/typescript-api/common/id#id'>ID</a>`>``}   />

package/docs/reference/typescript-api/import-export/import-parser.mdx CHANGED Viewed

@@ -17,7 +17,7 @@ class ImportParser {
 ### parseProducts
-<MemberInfo kind="method" type={`(input: string | Stream, mainLanguage: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a> = this.configService.defaultLanguageCode) => Promise<<a href='/reference/typescript-api/import-export/import-parser#parseresult'>ParseResult</a>`<<a href='/reference/typescript-api/import-export/import-parser#parsedproductwithvariants'>`ParsedProductWithVariants</a>>>`}   />
+<MemberInfo kind="method" type={`(input: string | Stream, mainLanguage: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a> = this.configService.defaultLanguageCode) => `Promise<`<a href='/reference/typescript-api/import-export/import-parser#parseresult'>ParseResult</a>`<`<a href='/reference/typescript-api/import-export/import-parser#parsedproductwithvariants'>ParsedProductWithVariants</a>`>>``}   />
 Parses the contents of the [product import CSV file](/guides/developer-guide/importing-data/#product-import-format) and
 returns a data structure which can then be used to populate Vendure using the <DocsLink href="/reference/typescript-api/import-export/fast-importer-service#fastimporterservice">FastImporterService</DocsLink>.
@@ -43,7 +43,7 @@ interface ParsedOptionGroup {
 ### translations
-<MemberInfo kind="property" type={`Array<{         languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>;         name: string;         values: string[];     }>`}   />
+<MemberInfo kind="property" type={``Array<{         languageCode: `<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>`;         name: string;         values: string[];     }>``}   />
@@ -68,7 +68,7 @@ interface ParsedFacet {
 ### translations
-<MemberInfo kind="property" type={`Array<{         languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>;         facet: string;         value: string;     }>`}   />
+<MemberInfo kind="property" type={``Array<{         languageCode: `<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>`;         facet: string;         value: string;     }>``}   />
@@ -137,7 +137,7 @@ interface ParsedProductVariant {
 ### translations
-<MemberInfo kind="property" type={`Array<{         languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>;         optionValues: string[];         customFields: {             [name: string]: string;         };     }>`}   />
+<MemberInfo kind="property" type={``Array<{         languageCode: `<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>`;         optionValues: string[];         customFields: {             [name: string]: string;         };     }>``}   />
@@ -184,7 +184,7 @@ interface ParsedProduct {
 ### translations
-<MemberInfo kind="property" type={`Array<{         languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>;         name: string;         slug: string;         description: string;         customFields: {             [name: string]: string;         };     }>`}   />
+<MemberInfo kind="property" type={``Array<{         languageCode: `<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>`;         name: string;         slug: string;         description: string;         customFields: {             [name: string]: string;         };     }>``}   />

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

@@ -23,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<ImportProgress>`}   />
+<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.
@@ -31,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<string[]>`}   />
+<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<<a href='/reference/typescript-api/common/id#id'>ID</a>[]>`}   />
+<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 CHANGED Viewed

@@ -43,17 +43,17 @@ interface InitialData {
 ### taxRates
-<MemberInfo kind="property" type={`Array<{ name: string; percentage: number }>`}   />
+<MemberInfo kind="property" type={``Array<{ name: string; percentage: number }>``}   />
 ### shippingMethods
-<MemberInfo kind="property" type={`Array<{ name: string; price: number; taxRate?: number }>`}   />
+<MemberInfo kind="property" type={``Array<{ name: string; price: number; taxRate?: number }>``}   />
 ### paymentMethods
-<MemberInfo kind="property" type={`Array<{ name: string; handler: ConfigurableOperationInput }>`}   />
+<MemberInfo kind="property" type={``Array<{ name: string; handler: ConfigurableOperationInput }>``}   />
 ### collections

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

@@ -50,7 +50,7 @@ Parameters
 ### bootstrapFn
-<MemberInfo kind="parameter" type={`() => Promise<T | undefined>`} />
+<MemberInfo kind="parameter" type={``() => Promise<T | undefined>``} />
 ### initialDataPathOrObject

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

@@ -125,7 +125,7 @@ class DefaultJobQueuePlugin {
 ### init
-<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>>`}   />
+<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>`>``}   />
@@ -158,7 +158,7 @@ interface DefaultJobQueueOptions {
 ### pollInterval
-<MemberInfo kind="property" type={`number | ((queueName: string) => 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
@@ -170,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={`() => 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>) => 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
@@ -222,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 => 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 CHANGED Viewed

@@ -32,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<<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>`>``}   />
 ### bufferSize
-<MemberInfo kind="method" type={`(bufferIds?: string[]) => Promise<{ [bufferId: string]: number }>`}   />
+<MemberInfo kind="method" type={`(bufferIds?: string[]) => `Promise<{ [bufferId: string]: number }>``}   />
 ### 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>`[] }>``}   />

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

@@ -40,7 +40,7 @@ class JobQueue<Data extends JobData<Data> = object> {
 ### 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,12 +61,12 @@ 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
@@ -83,7 +83,7 @@ Removes a <DocsLink href="/reference/typescript-api/job-queue/job-buffer#jobbuff
 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/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.