npm - @vendure/docs - Versions diffs - 0.0.0-202601201808 → 0.0.0-202601210957 - Mend

@vendure/docs 0.0.0-202601201808 → 0.0.0-202601210957

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

package/docs/reference/core-plugins/email-plugin/email-sender.mdx CHANGED Viewed

@@ -56,7 +56,7 @@ interface EmailSender extends InjectableStrategy {
 ### send
-<MemberInfo kind="property" type={`(email: <a href='/reference/core-plugins/email-plugin/email-plugin-types#emaildetails'>EmailDetails</a>, options: <a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a>) =&#62; void | Promise&#60;void&#62;`}   />
+<MemberInfo kind="property" type={`(email: <a href='/reference/core-plugins/email-plugin/email-plugin-types#emaildetails'>EmailDetails</a>, options: <a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a>) => void | Promise<void>`}   />

package/docs/reference/core-plugins/email-plugin/index.mdx CHANGED Viewed

@@ -290,7 +290,7 @@ class EmailPlugin implements OnApplicationBootstrap, OnApplicationShutdown, Nest
 ### init
-<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/email-plugin/email-plugin-options#emailpluginoptions'>EmailPluginOptions</a> | <a href='/reference/core-plugins/email-plugin/email-plugin-options#emailplugindevmodeoptions'>EmailPluginDevModeOptions</a>) => Type&#60;<a href='/reference/core-plugins/email-plugin/#emailplugin'>EmailPlugin</a>&#62;`}   />
+<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/email-plugin/email-plugin-options#emailpluginoptions'>EmailPluginOptions</a> | <a href='/reference/core-plugins/email-plugin/email-plugin-options#emailplugindevmodeoptions'>EmailPluginDevModeOptions</a>) => Type<<a href='/reference/core-plugins/email-plugin/#emailplugin'>EmailPlugin</a>>`}   />
 ### onApplicationShutdown

package/docs/reference/core-plugins/email-plugin/template-loader.mdx CHANGED Viewed

@@ -41,12 +41,12 @@ interface TemplateLoader {
 ### loadTemplate
-<MemberInfo kind="method" type={`(injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loadtemplateinput'>LoadTemplateInput</a>) => Promise&#60;string&#62;`}   />
+<MemberInfo kind="method" type={`(injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loadtemplateinput'>LoadTemplateInput</a>) => Promise<string>`}   />
 Load template and return it's content as a string
 ### loadPartials
-<MemberInfo kind="method" type={`() => Promise&#60;Partial[]&#62;`}   />
+<MemberInfo kind="method" type={`() => Promise<Partial[]>`}   />
 Load partials and return their contents.
 This method is only called during initialization, i.e. during server startup.
@@ -82,12 +82,12 @@ class FileBasedTemplateLoader implements TemplateLoader {
 ### loadTemplate
-<MemberInfo kind="method" type={`(_injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, _ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, { type, templateName }: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loadtemplateinput'>LoadTemplateInput</a>) => Promise&#60;string&#62;`}   />
+<MemberInfo kind="method" type={`(_injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, _ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, { type, templateName }: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loadtemplateinput'>LoadTemplateInput</a>) => Promise<string>`}   />
 ### loadPartials
-<MemberInfo kind="method" type={`() => Promise&#60;Partial[]&#62;`}   />
+<MemberInfo kind="method" type={`() => Promise<Partial[]>`}   />

package/docs/reference/core-plugins/email-plugin/transport-options.mdx CHANGED Viewed

@@ -232,7 +232,7 @@ interface TestingTransportOptions {
 ### onSend
-<MemberInfo kind="property" type={`(details: <a href='/reference/core-plugins/email-plugin/email-plugin-types#emaildetails'>EmailDetails</a>) =&#62; void`}   />
+<MemberInfo kind="property" type={`(details: <a href='/reference/core-plugins/email-plugin/email-plugin-types#emaildetails'>EmailDetails</a>) => void`}   />
 Callback to be invoked when an email would be sent.

package/docs/reference/core-plugins/graphiql-plugin/index.mdx CHANGED Viewed

@@ -65,7 +65,7 @@ class GraphiqlPlugin implements NestModule {
 ### options
-<MemberInfo kind="property" type={`Required&#60;GraphiqlPluginOptions&#62;`}   />
+<MemberInfo kind="property" type={`Required<GraphiqlPluginOptions>`}   />
 ### constructor
@@ -75,7 +75,7 @@ class GraphiqlPlugin implements NestModule {
 ### init
-<MemberInfo kind="method" type={`(options: GraphiqlPluginOptions = {}) => Type&#60;<a href='/reference/core-plugins/graphiql-plugin/#graphiqlplugin'>GraphiqlPlugin</a>&#62;`}   />
+<MemberInfo kind="method" type={`(options: GraphiqlPluginOptions = {}) => Type<<a href='/reference/core-plugins/graphiql-plugin/#graphiqlplugin'>GraphiqlPlugin</a>>`}   />
 ### configure

package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx CHANGED Viewed

@@ -89,7 +89,7 @@ When set to `'prod'`, the plugin will disable dev-mode features of the GraphQL A
 - GraphQL playground
 ### skip
-<MemberInfo kind="property" type={`(context: GraphQLRequestContext&#60;any&#62;) =&#62; Promise&#60;boolean&#62; | boolean`}   />
+<MemberInfo kind="property" type={`(context: GraphQLRequestContext<any>) => Promise<boolean> | boolean`}   />
 Allows you to skip the complexity check for certain requests.

package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx CHANGED Viewed

@@ -39,7 +39,7 @@ class BullMQJobQueueStrategy implements InspectableJobQueueStrategy {
 ### init
-<MemberInfo kind="method" type={`(injector: Injector) => Promise&#60;void&#62;`}   />
+<MemberInfo kind="method" type={`(injector: Injector) => Promise<void>`}   />
 ### destroy
@@ -49,42 +49,42 @@ class BullMQJobQueueStrategy implements InspectableJobQueueStrategy {
 ### add
-<MemberInfo kind="method" type={`(job: Job&#60;Data&#62;) => Promise&#60;Job&#60;Data&#62;&#62;`}   />
+<MemberInfo kind="method" type={`(job: Job<Data>) => Promise<Job<Data>>`}   />
 ### cancelJob
-<MemberInfo kind="method" type={`(jobId: string) => Promise&#60;Job | undefined&#62;`}   />
+<MemberInfo kind="method" type={`(jobId: string) => Promise<Job | undefined>`}   />
 ### findMany
-<MemberInfo kind="method" type={`(options?: JobListOptions) => Promise&#60;PaginatedList&#60;Job&#62;&#62;`}   />
+<MemberInfo kind="method" type={`(options?: JobListOptions) => Promise<PaginatedList<Job>>`}   />
 ### findManyById
-<MemberInfo kind="method" type={`(ids: ID[]) => Promise&#60;Job[]&#62;`}   />
+<MemberInfo kind="method" type={`(ids: ID[]) => Promise<Job[]>`}   />
 ### findOne
-<MemberInfo kind="method" type={`(id: ID) => Promise&#60;Job | undefined&#62;`}   />
+<MemberInfo kind="method" type={`(id: ID) => Promise<Job | undefined>`}   />
 ### removeSettledJobs
-<MemberInfo kind="method" type={`(queueNames?: string[], olderThan?: Date) => Promise&#60;number&#62;`}   />
+<MemberInfo kind="method" type={`(queueNames?: string[], olderThan?: Date) => Promise<number>`}   />
 ### start
-<MemberInfo kind="method" type={`(queueName: string, process: (job: Job&#60;Data&#62;) =&#62; Promise&#60;any&#62;) => Promise&#60;void&#62;`}   />
+<MemberInfo kind="method" type={`(queueName: string, process: (job: Job<Data>) => Promise<any>) => Promise<void>`}   />
 ### stop
-<MemberInfo kind="method" type={`(queueName: string, process: (job: Job&#60;Data&#62;) =&#62; Promise&#60;any&#62;) => Promise&#60;void&#62;`}   />
+<MemberInfo kind="method" type={`(queueName: string, process: (job: Job<Data>) => Promise<any>) => Promise<void>`}   />

package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx CHANGED Viewed

@@ -33,21 +33,21 @@ creating a new Queue, Worker and Scheduler instance.
 If omitted, it will attempt to connect to Redis at `127.0.0.1:6379`.
 ### queueOptions
-<MemberInfo kind="property" type={`Omit&#60;QueueOptions, 'connection'&#62;`}   />
+<MemberInfo kind="property" type={`Omit<QueueOptions, 'connection'>`}   />
 Additional options used when instantiating the BullMQ
 Queue instance.
 See the [BullMQ QueueOptions docs](https://github.com/taskforcesh/bullmq/blob/master/docs/gitbook/api/bullmq.queueoptions.md)
 ### workerOptions
-<MemberInfo kind="property" type={`Omit&#60;WorkerOptions, 'connection'&#62;`}   />
+<MemberInfo kind="property" type={`Omit<WorkerOptions, 'connection'>`}   />
 Additional options used when instantiating the BullMQ
 Worker instance.
 See the [BullMQ WorkerOptions docs](https://github.com/taskforcesh/bullmq/blob/master/docs/gitbook/api/bullmq.workeroptions.md)
 ### setRetries
-<MemberInfo kind="property" type={`(queueName: string, job: Job) =&#62; number`}  since="1.3.0"  />
+<MemberInfo kind="property" type={`(queueName: string, job: Job) => number`}  since="1.3.0"  />
 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
@@ -69,7 +69,7 @@ setRetries: (queueName, job) => {
  ```
 ### setBackoff
-<MemberInfo kind="property" type={`(queueName: string, job: Job) =&#62; <a href='/reference/core-plugins/job-queue-plugin/bull-mqplugin-options#backoffoptions'>BackoffOptions</a> | undefined`} default={`'exponential', 1000`}  since="1.3.0"  />
+<MemberInfo kind="property" type={`(queueName: string, job: Job) => <a href='/reference/core-plugins/job-queue-plugin/bull-mqplugin-options#backoffoptions'>BackoffOptions</a> | undefined`} default={`'exponential', 1000`}  since="1.3.0"  />
 This allows you to specify the backoff settings when a failed job gets retried.
 In other words, this determines how much time should pass before attempting to
@@ -88,7 +88,7 @@ setBackoff: (queueName, job) => {
 ```
 ### setJobOptions
-<MemberInfo kind="property" type={`(queueName: string, job: Job) =&#62; BullJobsOptions`}  since="3.2.0"  />
+<MemberInfo kind="property" type={`(queueName: string, job: Job) => BullJobsOptions`}  since="3.2.0"  />
 This allows you to specify additional options for a job when it is added to the queue.
 The object returned is the BullMQ [JobsOptions](https://api.docs.bullmq.io/types/v5.JobsOptions.html)

package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx CHANGED Viewed

@@ -46,17 +46,17 @@ class PubSubJobQueueStrategy extends InjectableJobQueueStrategy implements JobQu
 ### add
-<MemberInfo kind="method" type={`(job: Job&#60;Data&#62;) => Promise&#60;Job&#60;Data&#62;&#62;`}   />
+<MemberInfo kind="method" type={`(job: Job<Data>) => Promise<Job<Data>>`}   />
 ### start
-<MemberInfo kind="method" type={`(queueName: string, process: (job: Job&#60;Data&#62;) =&#62; Promise&#60;any&#62;) => `}   />
+<MemberInfo kind="method" type={`(queueName: string, process: (job: Job<Data>) => Promise<any>) => `}   />
 ### stop
-<MemberInfo kind="method" type={`(queueName: string, process: (job: Job&#60;Data&#62;) =&#62; Promise&#60;any&#62;) => `}   />
+<MemberInfo kind="method" type={`(queueName: string, process: (job: Job<Data>) => Promise<any>) => `}   />

package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx CHANGED Viewed

@@ -27,7 +27,7 @@ class PubSubPlugin {
 ### init
-<MemberInfo kind="method" type={`(options: PubSubOptions) => Type&#60;<a href='/reference/core-plugins/job-queue-plugin/pub-sub-plugin#pubsubplugin'>PubSubPlugin</a>&#62;`}   />
+<MemberInfo kind="method" type={`(options: PubSubOptions) => Type<<a href='/reference/core-plugins/job-queue-plugin/pub-sub-plugin#pubsubplugin'>PubSubPlugin</a>>`}   />

package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx CHANGED Viewed

@@ -251,7 +251,7 @@ class BraintreePlugin {
 ### init
-<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/payments-plugin/braintree-plugin#braintreepluginoptions'>BraintreePluginOptions</a>) => Type&#60;<a href='/reference/core-plugins/payments-plugin/braintree-plugin#braintreeplugin'>BraintreePlugin</a>&#62;`}   />
+<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/payments-plugin/braintree-plugin#braintreepluginoptions'>BraintreePluginOptions</a>) => Type<<a href='/reference/core-plugins/payments-plugin/braintree-plugin#braintreeplugin'>BraintreePlugin</a>>`}   />
@@ -293,7 +293,7 @@ Since v1.8, it is possible to override vaulting on a per-payment basis by passin
 `generateBraintreeClientToken` mutation.
 ### extractMetadata
-<MemberInfo kind="property" type={`(transaction: <a href='/reference/typescript-api/request/transaction-decorator#transaction'>Transaction</a>) =&#62; PaymentMetadata`}  since="1.7.0"  />
+<MemberInfo kind="property" type={`(transaction: <a href='/reference/typescript-api/request/transaction-decorator#transaction'>Transaction</a>) => PaymentMetadata`}  since="1.7.0"  />
 Allows you to configure exactly what information from the Braintree
 [Transaction object](https://developer.paypal.com/braintree/docs/reference/response/transaction#result-object) (which is returned by the

package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx CHANGED Viewed

@@ -169,7 +169,7 @@ The host of your Vendure server, e.g. `'https://my-vendure.io'`.
 This is used by Mollie to send webhook events to the Vendure server
 ### enabledPaymentMethodsParams
-<MemberInfo kind="property" type={`(         injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,         ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,         order: <a href='/reference/typescript-api/entities/order#order'>Order</a> | null,     ) =&#62; AdditionalEnabledPaymentMethodsParams | Promise&#60;AdditionalEnabledPaymentMethodsParams&#62;`}  since="2.2.0"  />
+<MemberInfo kind="property" type={`(         injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,         ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,         order: <a href='/reference/typescript-api/entities/order#order'>Order</a> | null,     ) => AdditionalEnabledPaymentMethodsParams | Promise<AdditionalEnabledPaymentMethodsParams>`}  since="2.2.0"  />
 Provide additional parameters to the Mollie enabled payment methods API call. By default,
 the plugin will already pass the `resource` parameter.

package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx CHANGED Viewed

@@ -167,7 +167,7 @@ class StripePlugin {
 ### init
-<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/payments-plugin/stripe-plugin#stripepluginoptions'>StripePluginOptions</a>) => Type&#60;<a href='/reference/core-plugins/payments-plugin/stripe-plugin#stripeplugin'>StripePlugin</a>&#62;`}   />
+<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/payments-plugin/stripe-plugin#stripepluginoptions'>StripePluginOptions</a>) => Type<<a href='/reference/core-plugins/payments-plugin/stripe-plugin#stripeplugin'>StripePlugin</a>>`}   />
 Initialize the Stripe payment plugin
@@ -220,7 +220,7 @@ to be used with the same PaymentIntent. This is done by adding a custom field to
 the Stripe customer ID, so switching this on will require a database migration / synchronization.
 ### metadata
-<MemberInfo kind="property" type={`(         injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,         ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,         order: <a href='/reference/typescript-api/entities/order#order'>Order</a>,     ) =&#62; Stripe.MetadataParam | Promise&#60;Stripe.MetadataParam&#62;`}  since="1.9.7"  />
+<MemberInfo kind="property" type={`(         injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,         ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,         order: <a href='/reference/typescript-api/entities/order#order'>Order</a>,     ) => Stripe.MetadataParam | Promise<Stripe.MetadataParam>`}  since="1.9.7"  />
 Attach extra metadata to Stripe payment intent creation call.
@@ -250,7 +250,7 @@ Note: If the `paymentIntentCreateParams` is also used and returns a `metadata` k
 returned by both functions will be merged.
 ### paymentIntentCreateParams
-<MemberInfo kind="property" type={`(         injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,         ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,         order: <a href='/reference/typescript-api/entities/order#order'>Order</a>,     ) =&#62; AdditionalPaymentIntentCreateParams | Promise&#60;AdditionalPaymentIntentCreateParams&#62;`}  since="2.1.0"  />
+<MemberInfo kind="property" type={`(         injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,         ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,         order: <a href='/reference/typescript-api/entities/order#order'>Order</a>,     ) => AdditionalPaymentIntentCreateParams | Promise<AdditionalPaymentIntentCreateParams>`}  since="2.1.0"  />
 Provide additional parameters to the Stripe payment intent creation. By default,
 the plugin will already pass the `amount`, `currency`, `customer` and `automatic_payment_methods: { enabled: true }` parameters.
@@ -278,7 +278,7 @@ export const config: VendureConfig = {
 ```
 ### requestOptions
-<MemberInfo kind="property" type={`(         injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,         ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,         order: <a href='/reference/typescript-api/entities/order#order'>Order</a>,     ) =&#62; AdditionalRequestOptions | Promise&#60;AdditionalRequestOptions&#62;`}  since="3.1.0"  />
+<MemberInfo kind="property" type={`(         injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,         ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,         order: <a href='/reference/typescript-api/entities/order#order'>Order</a>,     ) => AdditionalRequestOptions | Promise<AdditionalRequestOptions>`}  since="3.1.0"  />
 Provide additional options to the Stripe payment intent creation. By default,
 the plugin will already pass the `idempotencyKey` parameter.
@@ -306,7 +306,7 @@ export const config: VendureConfig = {
 ```
 ### customerCreateParams
-<MemberInfo kind="property" type={`(         injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,         ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,         order: <a href='/reference/typescript-api/entities/order#order'>Order</a>,     ) =&#62; AdditionalCustomerCreateParams | Promise&#60;AdditionalCustomerCreateParams&#62;`}  since="2.1.0"  />
+<MemberInfo kind="property" type={`(         injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,         ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,         order: <a href='/reference/typescript-api/entities/order#order'>Order</a>,     ) => AdditionalCustomerCreateParams | Promise<AdditionalCustomerCreateParams>`}  since="2.1.0"  />
 Provide additional parameters to the Stripe customer creation. By default,
 the plugin will already pass the `email` and `name` parameters.

package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx CHANGED Viewed

@@ -25,7 +25,7 @@ class PurgeRule<Event extends VendureEvent = VendureEvent> {
 ### eventType
-<MemberInfo kind="property" type={`Type&#60;Event&#62;`}   />
+<MemberInfo kind="property" type={`Type<Event>`}   />
 ### bufferTimeMs
@@ -40,7 +40,7 @@ class PurgeRule<Event extends VendureEvent = VendureEvent> {
 ### constructor
-<MemberInfo kind="method" type={`(config: <a href='/reference/core-plugins/stellate-plugin/purge-rule#purgeruleconfig'>PurgeRuleConfig</a>&#60;Event&#62;) => PurgeRule`}   />
+<MemberInfo kind="method" type={`(config: <a href='/reference/core-plugins/stellate-plugin/purge-rule#purgeruleconfig'>PurgeRuleConfig</a><Event>) => PurgeRule`}   />
@@ -70,7 +70,7 @@ interface PurgeRuleConfig<Event extends VendureEvent> {
 ### eventType
-<MemberInfo kind="property" type={`Type&#60;Event&#62;`}   />
+<MemberInfo kind="property" type={`Type<Event>`}   />
 Specifies which VendureEvent will trigger this purge rule.
 ### bufferTime
@@ -81,7 +81,7 @@ How long to buffer events for in milliseconds before executing the handler. This
 us to efficiently batch calls to the Stellate Purge API.
 ### handler
-<MemberInfo kind="property" type={`(handlerArgs: {         events: Event[];         stellateService: <a href='/reference/core-plugins/stellate-plugin/stellate-service#stellateservice'>StellateService</a>;         injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>;     }) =&#62; void | Promise&#60;void&#62;`}   />
+<MemberInfo kind="property" type={`(handlerArgs: {         events: Event[];         stellateService: <a href='/reference/core-plugins/stellate-plugin/stellate-service#stellateservice'>StellateService</a>;         injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>;     }) => void | Promise<void>`}   />
 The function to invoke when the specified event is published. This function should use the
 <a href='/reference/core-plugins/stellate-plugin/stellate-service#stellateservice'>StellateService</a> instance to call the Stellate Purge API.

package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx CHANGED Viewed

@@ -42,7 +42,7 @@ Purges the cache for the given Products.
 Purges the cache for the given ProductVariants.
 ### purgeSearchResults
-<MemberInfo kind="method" type={`(items: Array&#60;<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a> | <a href='/reference/typescript-api/entities/product#product'>Product</a>&#62;) => `}   />
+<MemberInfo kind="method" type={`(items: Array<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a> | <a href='/reference/typescript-api/entities/product#product'>Product</a>>) => `}   />
 Purges the cache for SearchResults which contain the given Products or ProductVariants.
 ### purgeAllOfType

package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx CHANGED Viewed

@@ -83,7 +83,7 @@ When set to `true`, the SDK will log spans to the console instead of sending the
 exporter. This should just be used for debugging purposes.
 ### config
-<MemberInfo kind="property" type={`Partial&#60;NodeSDKConfiguration&#62;`}   />
+<MemberInfo kind="property" type={`Partial<NodeSDKConfiguration>`}   />
 The configuration object for the OpenTelemetry Node SDK.

package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx CHANGED Viewed

@@ -37,9 +37,9 @@ Parameters
 ### target
-<MemberInfo kind="parameter" type={`Type&#60;T&#62;`} />
+<MemberInfo kind="parameter" type={`Type<T>`} />
 ### hooks
-<MemberInfo kind="parameter" type={`MethodHooksForType&#60;T&#62;`} />
+<MemberInfo kind="parameter" type={`MethodHooksForType<T>`} />

package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx CHANGED Viewed

@@ -38,7 +38,7 @@ TelemetryPlugin.init({
 ```
 ### methodHooks
-<MemberInfo kind="property" type={`Array&#60;MethodHookConfig&#60;any&#62;&#62;`}  experimental="true" />
+<MemberInfo kind="property" type={`Array<MethodHookConfig<any>>`}  experimental="true" />
 **Status: Developer Preview**

package/docs/reference/dashboard/components/asset-gallery.mdx CHANGED Viewed

@@ -60,7 +60,7 @@ interface AssetGalleryProps {
 ### onSelect
-<MemberInfo kind="property" type={`(assets: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[]) =&#62; void`}   />
+<MemberInfo kind="property" type={`(assets: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[]) => void`}   />
 ### selectable
@@ -103,7 +103,7 @@ Whether the gallery should show a header.
 The class name to apply to the gallery.
 ### onFilesDropped
-<MemberInfo kind="property" type={`(files: File[]) =&#62; void`}   />
+<MemberInfo kind="property" type={`(files: File[]) => void`}   />
 The function to call when files are dropped.
 ### bulkActions
@@ -118,7 +118,7 @@ The bulk actions to display in the gallery.
 Whether the gallery should display bulk actions.
 ### onPageSizeChange
-<MemberInfo kind="property" type={`(pageSize: number) =&#62; void`}   />
+<MemberInfo kind="property" type={`(pageSize: number) => void`}   />
 The function to call when the page size changes.

package/docs/reference/dashboard/components/asset-picker-dialog.mdx CHANGED Viewed

@@ -47,12 +47,12 @@ interface AssetPickerDialogProps {
 Whether the dialog is open.
 ### onClose
-<MemberInfo kind="property" type={`() =&#62; void`}   />
+<MemberInfo kind="property" type={`() => void`}   />
 The function to call when the dialog is closed.
 ### onSelect
-<MemberInfo kind="property" type={`(assets: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[]) =&#62; void`}   />
+<MemberInfo kind="property" type={`(assets: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[]) => void`}   />
 The function to call when assets are selected.
 ### multiSelect

package/docs/reference/dashboard/components/channel-chip.mdx CHANGED Viewed

@@ -17,5 +17,5 @@ Parameters
 ### props
-<MemberInfo kind="parameter" type={`Readonly&#60;ChannelChipProps&#62;`} />
+<MemberInfo kind="parameter" type={`Readonly<ChannelChipProps>`} />

package/docs/reference/dashboard/components/detail-page-button.mdx CHANGED Viewed

@@ -44,5 +44,5 @@ Parameters
 ### props
-<MemberInfo kind="parameter" type={`Readonly&#60;{     label: string | React.ReactNode;     id?: string;     href?: string;     disabled?: boolean;     search?: Record&#60;string, string&#62;;     className?: string; }&#62;`} />
+<MemberInfo kind="parameter" type={`Readonly<{     label: string | React.ReactNode;     id?: string;     href?: string;     disabled?: boolean;     search?: Record<string, string>;     className?: string; }>`} />

package/docs/reference/dashboard/components/facet-value-selector.mdx CHANGED Viewed

@@ -46,7 +46,7 @@ interface FacetValueSelectorProps {
 ### onValueSelect
-<MemberInfo kind="property" type={`(value: <a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>) =&#62; void`}   />
+<MemberInfo kind="property" type={`(value: <a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>) => void`}   />
 The function to call when a facet value is selected.

package/docs/reference/dashboard/components/permission-guard.mdx CHANGED Viewed

@@ -28,7 +28,7 @@ Parameters
 ### props
-<MemberInfo kind="parameter" type={`Readonly&#60;<a href='/reference/dashboard/components/permission-guard#permissionguardprops'>PermissionGuardProps</a>&#62;`} />
+<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/components/permission-guard#permissionguardprops'>PermissionGuardProps</a>>`} />

package/docs/reference/dashboard/components/vendure-image.mdx CHANGED Viewed

@@ -61,7 +61,7 @@ interface VendureImageProps extends React.ImgHTMLAttributes<HTMLImageElement> {
     ref?: React.Ref<HTMLImageElement>;
 }
 ```
-* Extends: <code>React.ImgHTMLAttributes&#60;HTMLImageElement&#62;</code>
+* Extends: <code>React.ImgHTMLAttributes<HTMLImageElement></code>
@@ -115,7 +115,7 @@ The fallback to show if no asset is provided. If no fallback is provided,
 a default placeholder will be shown.
 ### ref
-<MemberInfo kind="property" type={`React.Ref&#60;HTMLImageElement&#62;`}   />
+<MemberInfo kind="property" type={`React.Ref<HTMLImageElement>`}   />
 The ref to the image element.

package/docs/reference/dashboard/detail-views/detail-page.mdx CHANGED Viewed

@@ -19,7 +19,7 @@ Parameters
 ### props
-<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/detail-page#detailpageprops'>DetailPageProps</a>&#60;T, C, U&#62;`} />
+<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/detail-page#detailpageprops'>DetailPageProps</a><T, C, U>`} />
@@ -62,7 +62,7 @@ A unique identifier for the page.
 The Tanstack Router route used to navigate to this page.
 ### title
-<MemberInfo kind="property" type={`(entity: ResultOf&#60;T&#62;[EntityField]) =&#62; string`}   />
+<MemberInfo kind="property" type={`(entity: ResultOf<T>[EntityField]) => string`}   />
 The title of the page.
 ### queryDocument
@@ -82,7 +82,7 @@ The mutation document used to create the entity.
 The mutation document used to update the entity.
 ### setValuesForUpdate
-<MemberInfo kind="property" type={`(entity: ResultOf&#60;T&#62;[EntityField]) =&#62; VariablesOf&#60;U&#62;['input']`}   />
+<MemberInfo kind="property" type={`(entity: ResultOf<T>[EntityField]) => VariablesOf<U>['input']`}   />
 A function that sets the values for the update input type based on the entity.

package/docs/reference/dashboard/detail-views/use-detail-page.mdx CHANGED Viewed

@@ -78,7 +78,7 @@ Parameters
 ### options
-<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/use-detail-page#detailpageoptions'>DetailPageOptions</a>&#60;T, C, U, EntityField, VarNameCreate, VarNameUpdate&#62;`} />
+<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/use-detail-page#detailpageoptions'>DetailPageOptions</a><T, C, U, EntityField, VarNameCreate, VarNameUpdate>`} />
@@ -151,27 +151,27 @@ The document to create the entity.
 The document to update the entity.
 ### setValuesForUpdate
-<MemberInfo kind="property" type={`(         entity: NonNullable&#60;ResultOf&#60;T&#62;[EntityField]&#62;,     ) =&#62; WithLooseCustomFields&#60;VariablesOf&#60;U&#62;[VarNameUpdate]&#62;`}   />
+<MemberInfo kind="property" type={`(         entity: NonNullable<ResultOf<T>[EntityField]>,     ) => WithLooseCustomFields<VariablesOf<U>[VarNameUpdate]>`}   />
 The function to set the values for the update document.
 ### transformCreateInput
-<MemberInfo kind="property" type={`(input: VariablesOf&#60;C&#62;[VarNameCreate]) =&#62; VariablesOf&#60;C&#62;[VarNameCreate]`}   />
+<MemberInfo kind="property" type={`(input: VariablesOf<C>[VarNameCreate]) => VariablesOf<C>[VarNameCreate]`}   />
 ### transformUpdateInput
-<MemberInfo kind="property" type={`(input: VariablesOf&#60;U&#62;[VarNameUpdate]) =&#62; VariablesOf&#60;U&#62;[VarNameUpdate]`}   />
+<MemberInfo kind="property" type={`(input: VariablesOf<U>[VarNameUpdate]) => VariablesOf<U>[VarNameUpdate]`}   />
 ### onSuccess
-<MemberInfo kind="property" type={`(entity: ResultOf&#60;C&#62;[keyof ResultOf&#60;C&#62;] | ResultOf&#60;U&#62;[keyof ResultOf&#60;U&#62;]) =&#62; void`}   />
+<MemberInfo kind="property" type={`(entity: ResultOf<C>[keyof ResultOf<C>] | ResultOf<U>[keyof ResultOf<U>]) => void`}   />
 The function to call when the update is successful.
 ### onError
-<MemberInfo kind="property" type={`(error: unknown) =&#62; void`}   />
+<MemberInfo kind="property" type={`(error: unknown) => void`}   />
 The function to call when the update is successful.
@@ -200,17 +200,17 @@ interface UseDetailPageResult<T extends TypedDocumentNode<any, any>, U extends T
 ### form
-<MemberInfo kind="property" type={`UseFormReturn&#60;RemoveNullFields&#60;VariablesOf&#60;U&#62;['input']&#62;&#62;`}   />
+<MemberInfo kind="property" type={`UseFormReturn<RemoveNullFields<VariablesOf<U>['input']>>`}   />
 ### submitHandler
-<MemberInfo kind="property" type={`(event: FormEvent&#60;HTMLFormElement&#62;) =&#62; void`}   />
+<MemberInfo kind="property" type={`(event: FormEvent<HTMLFormElement>) => void`}   />
 ### entity
-<MemberInfo kind="property" type={`DetailPageEntity&#60;T, EntityField&#62;`}   />
+<MemberInfo kind="property" type={`DetailPageEntity<T, EntityField>`}   />
 ### isPending
@@ -220,12 +220,12 @@ interface UseDetailPageResult<T extends TypedDocumentNode<any, any>, U extends T
 ### refreshEntity
-<MemberInfo kind="property" type={`() =&#62; void`}   />
+<MemberInfo kind="property" type={`() => void`}   />
 ### resetForm
-<MemberInfo kind="property" type={`() =&#62; void`}   />
+<MemberInfo kind="property" type={`() => void`}   />