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/entities/region.mdx CHANGED Viewed

@@ -69,7 +69,7 @@ a format relevant to the type of province, e.g. a US state code like "CA".
 ### translations
-<MemberInfo kind="property" type={``Array<Translation<`<a href='/reference/typescript-api/entities/region#region'>Region</a>`>>``}   />
+<MemberInfo kind="property" type={`Array<Translation<<a href='/reference/typescript-api/entities/region#region'>Region</a>>>`}   />
 ### customFields

package/docs/reference/typescript-api/entities/role.mdx CHANGED Viewed

@@ -29,7 +29,7 @@ class Role extends VendureEntity implements ChannelAware {
 ### constructor
-<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/role#role'>Role</a>`>`) => Role`}   />
+<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/role#role'>Role</a>>) => Role`}   />
 ### code

package/docs/reference/typescript-api/entities/seller.mdx CHANGED Viewed

@@ -30,7 +30,7 @@ class Seller extends VendureEntity implements SoftDeletable, HasCustomFields {
 ### constructor
-<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/seller#seller'>Seller</a>`>`) => Seller`}   />
+<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/seller#seller'>Seller</a>>) => Seller`}   />
 ### deletedAt

package/docs/reference/typescript-api/entities/settings-store-entry.mdx CHANGED Viewed

@@ -29,7 +29,7 @@ class SettingsStoreEntry extends VendureEntity {
 ### constructor
-<MemberInfo kind="method" type={`(input?: `Partial<`<a href='/reference/typescript-api/entities/settings-store-entry#settingsstoreentry'>SettingsStoreEntry</a>`>`) => SettingsStoreEntry`}   />
+<MemberInfo kind="method" type={`(input?: Partial<<a href='/reference/typescript-api/entities/settings-store-entry#settingsstoreentry'>SettingsStoreEntry</a>>) => SettingsStoreEntry`}   />
 ### key

package/docs/reference/typescript-api/entities/shipping-line.mdx CHANGED Viewed

@@ -52,7 +52,7 @@ class ShippingLine extends VendureEntity implements HasCustomFields {
 ### constructor
-<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/shipping-line#shippingline'>ShippingLine</a>`>`) => ShippingLine`}   />
+<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/shipping-line#shippingline'>ShippingLine</a>>) => ShippingLine`}   />
 ### shippingMethodId

package/docs/reference/typescript-api/entities/shipping-method.mdx CHANGED Viewed

@@ -45,7 +45,7 @@ class ShippingMethod extends VendureEntity implements ChannelAware, SoftDeletabl
 ### constructor
-<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>`>`) => ShippingMethod`}   />
+<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>>) => ShippingMethod`}   />
 ### deletedAt
@@ -90,7 +90,7 @@ class ShippingMethod extends VendureEntity implements ChannelAware, SoftDeletabl
 ### translations
-<MemberInfo kind="property" type={``Array<Translation<`<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>`>>``}   />
+<MemberInfo kind="property" type={`Array<Translation<<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>>>`}   />
 ### customFields
@@ -100,12 +100,12 @@ class ShippingMethod extends VendureEntity implements ChannelAware, SoftDeletabl
 ### apply
-<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>) => `Promise<`<a href='/reference/typescript-api/shipping/shipping-calculator#shippingcalculationresult'>ShippingCalculationResult</a>` | undefined>``}   />
+<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>) => Promise<<a href='/reference/typescript-api/shipping/shipping-calculator#shippingcalculationresult'>ShippingCalculationResult</a> | undefined>`}   />
 ### test
-<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>) => `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>) => Promise<boolean>`}   />
 ### toJSON

package/docs/reference/typescript-api/entities/stock-level.mdx CHANGED Viewed

@@ -39,7 +39,7 @@ class StockLevel extends VendureEntity implements HasCustomFields {
 ### constructor
-<MemberInfo kind="method" type={`(input: `DeepPartial<`<a href='/reference/typescript-api/entities/stock-level#stocklevel'>StockLevel</a>`>`) => StockLevel`}   />
+<MemberInfo kind="method" type={`(input: DeepPartial<<a href='/reference/typescript-api/entities/stock-level#stocklevel'>StockLevel</a>>) => StockLevel`}   />
 ### productVariant

package/docs/reference/typescript-api/entities/stock-location.mdx CHANGED Viewed

@@ -38,7 +38,7 @@ class StockLocation extends VendureEntity implements HasCustomFields, ChannelAwa
 ### constructor
-<MemberInfo kind="method" type={`(input: `DeepPartial<`<a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>`>`) => StockLocation`}   />
+<MemberInfo kind="method" type={`(input: DeepPartial<<a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>>) => StockLocation`}   />
 ### name

package/docs/reference/typescript-api/entities/stock-movement.mdx CHANGED Viewed

@@ -94,7 +94,7 @@ class Allocation extends StockMovement {
 ### constructor
-<MemberInfo kind="method" type={`(input: `DeepPartial<`<a href='/reference/typescript-api/entities/stock-movement#allocation'>Allocation</a>`>`) => Allocation`}   />
+<MemberInfo kind="method" type={`(input: DeepPartial<<a href='/reference/typescript-api/entities/stock-movement#allocation'>Allocation</a>>) => Allocation`}   />
 ### orderLine
@@ -130,7 +130,7 @@ class Cancellation extends StockMovement {
 ### constructor
-<MemberInfo kind="method" type={`(input: `DeepPartial<`<a href='/reference/typescript-api/entities/stock-movement#cancellation'>Cancellation</a>`>`) => Cancellation`}   />
+<MemberInfo kind="method" type={`(input: DeepPartial<<a href='/reference/typescript-api/entities/stock-movement#cancellation'>Cancellation</a>>) => Cancellation`}   />
 ### orderLine
@@ -167,7 +167,7 @@ class Release extends StockMovement {
 ### constructor
-<MemberInfo kind="method" type={`(input: `DeepPartial<`<a href='/reference/typescript-api/entities/stock-movement#release'>Release</a>`>`) => Release`}   />
+<MemberInfo kind="method" type={`(input: DeepPartial<<a href='/reference/typescript-api/entities/stock-movement#release'>Release</a>>) => Release`}   />
 ### orderLine
@@ -203,7 +203,7 @@ class Sale extends StockMovement {
 ### constructor
-<MemberInfo kind="method" type={`(input: `DeepPartial<`<a href='/reference/typescript-api/entities/stock-movement#sale'>Sale</a>`>`) => Sale`}   />
+<MemberInfo kind="method" type={`(input: DeepPartial<<a href='/reference/typescript-api/entities/stock-movement#sale'>Sale</a>>) => Sale`}   />
 ### orderLine
@@ -237,7 +237,7 @@ class StockAdjustment extends StockMovement {
 ### constructor
-<MemberInfo kind="method" type={`(input: `DeepPartial<`<a href='/reference/typescript-api/entities/stock-movement#stockadjustment'>StockAdjustment</a>`>`) => StockAdjustment`}   />
+<MemberInfo kind="method" type={`(input: DeepPartial<<a href='/reference/typescript-api/entities/stock-movement#stockadjustment'>StockAdjustment</a>>) => StockAdjustment`}   />

package/docs/reference/typescript-api/entities/surcharge.mdx CHANGED Viewed

@@ -39,7 +39,7 @@ class Surcharge extends VendureEntity {
 ### constructor
-<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/surcharge#surcharge'>Surcharge</a>`>`) => Surcharge`}   />
+<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/surcharge#surcharge'>Surcharge</a>>) => Surcharge`}   />
 ### description

package/docs/reference/typescript-api/entities/tag.mdx CHANGED Viewed

@@ -22,7 +22,7 @@ class Tag extends VendureEntity {
 ### constructor
-<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/tag#tag'>Tag</a>`>`) => Tag`}   />
+<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/tag#tag'>Tag</a>>) => Tag`}   />
 ### value

package/docs/reference/typescript-api/entities/tax-category.mdx CHANGED Viewed

@@ -30,7 +30,7 @@ class TaxCategory extends VendureEntity implements HasCustomFields {
 ### constructor
-<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/tax-category#taxcategory'>TaxCategory</a>`>`) => TaxCategory`}   />
+<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/tax-category#taxcategory'>TaxCategory</a>>) => TaxCategory`}   />
 ### name

package/docs/reference/typescript-api/entities/tax-rate.mdx CHANGED Viewed

@@ -50,7 +50,7 @@ class TaxRate extends VendureEntity implements HasCustomFields {
 ### constructor
-<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a>`>`) => TaxRate`}   />
+<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a>>) => TaxRate`}   />
 ### name

package/docs/reference/typescript-api/entities/user.mdx CHANGED Viewed

@@ -43,7 +43,7 @@ class User extends VendureEntity implements HasCustomFields, SoftDeletable {
 ### constructor
-<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/user#user'>User</a>`>`) => User`}   />
+<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/user#user'>User</a>>) => User`}   />
 ### deletedAt

package/docs/reference/typescript-api/entities/vendure-entity.mdx CHANGED Viewed

@@ -21,7 +21,7 @@ class VendureEntity {
 ### constructor
-<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/vendure-entity#vendureentity'>VendureEntity</a>`>`) => VendureEntity`}   />
+<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/vendure-entity#vendureentity'>VendureEntity</a>>) => VendureEntity`}   />
 ### id

package/docs/reference/typescript-api/entities/zone.mdx CHANGED Viewed

@@ -35,7 +35,7 @@ class Zone extends VendureEntity implements HasCustomFields {
 ### constructor
-<MemberInfo kind="method" type={`(input?: `DeepPartial<`<a href='/reference/typescript-api/entities/zone#zone'>Zone</a>`>`) => Zone`}   />
+<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/zone#zone'>Zone</a>>) => Zone`}   />
 ### name

package/docs/reference/typescript-api/errors/error-handler-strategy.mdx CHANGED Viewed

@@ -68,13 +68,13 @@ interface ErrorHandlerStrategy extends InjectableStrategy {
 ### handleServerError
-<MemberInfo kind="method" type={`(exception: Error, context: { host: ArgumentsHost }) => `void | Promise<void>``}   />
+<MemberInfo kind="method" type={`(exception: Error, context: { host: ArgumentsHost }) => void | Promise<void>`}   />
 This method will be invoked for any error thrown during the execution of the
 server.
 ### handleWorkerError
-<MemberInfo kind="method" type={`(exception: Error, context: { job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a> }) => `void | Promise<void>``}   />
+<MemberInfo kind="method" type={`(exception: Error, context: { job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a> }) => void | Promise<void>`}   />
 This method will be invoked for any error thrown during the execution of a
 job on the worker.

package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx CHANGED Viewed

@@ -20,13 +20,13 @@ type BlockingEventHandlerOptions<T extends VendureEvent> = {
 ### event
-<MemberInfo kind="property" type={``Type<T> | Array<Type<T>>``}   />
+<MemberInfo kind="property" type={`Type<T> | Array<Type<T>>`}   />
 The event type to which the handler should listen.
 Can be a single event type or an array of event types.
 ### handler
-<MemberInfo kind="property" type={``(event: T) => void | Promise<void>``}   />
+<MemberInfo kind="property" type={`(event: T) => void | Promise<void>`}   />
 The handler function which will be executed when the event is published.
 If the handler returns a Promise, the event publishing code will wait for the Promise to resolve

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
@@ -97,7 +97,7 @@ This means that the subscriber function can safely access all updated
 data related to the event.
 ### registerBlockingEventHandler
-<MemberInfo kind="method" type={`(handlerOptions: <a href='/reference/typescript-api/events/blocking-event-handler-options#blockingeventhandleroptions'>BlockingEventHandlerOptions</a>`<T>`) => `}  since="2.2.0"  />
+<MemberInfo kind="method" type={`(handlerOptions: <a href='/reference/typescript-api/events/blocking-event-handler-options#blockingeventhandleroptions'>BlockingEventHandlerOptions</a><T>) => `}  since="2.2.0"  />
 Register an event handler function which will be executed when an event of the given type is published,
 and will block execution of the code which published the event until the handler has completed.

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

@@ -91,7 +91,7 @@ class FulfillmentHandler<T extends ConfigArgs = ConfigArgs> extends Configurable
 ### constructor
-<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/fulfillment/fulfillment-handler#fulfillmenthandlerconfig'>FulfillmentHandlerConfig</a>`<T>`) => FulfillmentHandler`}   />
+<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/fulfillment/fulfillment-handler#fulfillmenthandlerconfig'>FulfillmentHandlerConfig</a><T>) => FulfillmentHandler`}   />
@@ -115,7 +115,7 @@ interface FulfillmentHandlerConfig<T extends ConfigArgs> extends ConfigurableOpe
 ### createFulfillment
-<MemberInfo kind="property" type={`<a href='/reference/typescript-api/fulfillment/fulfillment-handler#createfulfillmentfn'>CreateFulfillmentFn</a>`<T>``}   />
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/fulfillment/fulfillment-handler#createfulfillmentfn'>CreateFulfillmentFn</a><T>`}   />
 Invoked when the `addFulfillmentToOrder` mutation is executed with this handler selected.
@@ -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>[] }>`}   />