@vendure/docs 0.0.0-202601201656 → 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 (378) hide show
  1. package/dist/manifest.d.ts +1 -2
  2. package/dist/manifest.d.ts.map +1 -1
  3. package/dist/manifest.js +55 -1
  4. package/dist/manifest.js.map +1 -1
  5. package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +1 -1
  6. package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +2 -2
  7. package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +3 -3
  8. package/docs/reference/admin-ui-api/alerts/alert-config.mdx +5 -5
  9. package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +6 -6
  10. package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +4 -4
  11. package/docs/reference/admin-ui-api/components/currency-input-component.mdx +4 -4
  12. package/docs/reference/admin-ui-api/components/data-table-component.mdx +5 -5
  13. package/docs/reference/admin-ui-api/components/data-table2component.mdx +7 -7
  14. package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +7 -7
  15. package/docs/reference/admin-ui-api/components/dropdown-component.mdx +1 -1
  16. package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +6 -6
  17. package/docs/reference/admin-ui-api/components/object-tree-component.mdx +1 -1
  18. package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx +1 -1
  19. package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +2 -2
  20. package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +3 -3
  21. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +1 -1
  22. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.mdx +1 -1
  23. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +4 -4
  24. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -1
  25. package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +22 -22
  26. package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +1 -1
  27. package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +1 -1
  28. package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.mdx +1 -1
  29. package/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx +2 -2
  30. package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +2 -2
  31. package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +6 -6
  32. package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +1 -1
  33. package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +8 -8
  34. package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -1
  35. package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +3 -3
  36. package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +7 -7
  37. package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx +3 -3
  38. package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -1
  39. package/docs/reference/admin-ui-api/react-components/action-bar.mdx +1 -1
  40. package/docs/reference/admin-ui-api/react-components/card.mdx +1 -1
  41. package/docs/reference/admin-ui-api/react-components/cds-icon.mdx +1 -1
  42. package/docs/reference/admin-ui-api/react-components/form-field.mdx +1 -1
  43. package/docs/reference/admin-ui-api/react-components/link.mdx +1 -1
  44. package/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx +1 -1
  45. package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.mdx +1 -1
  46. package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +1 -1
  47. package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx +1 -1
  48. package/docs/reference/admin-ui-api/react-hooks/use-injector.mdx +1 -1
  49. package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx +1 -1
  50. package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx +1 -1
  51. package/docs/reference/admin-ui-api/react-hooks/use-query.mdx +1 -1
  52. package/docs/reference/admin-ui-api/routes/register-route-component.mdx +1 -1
  53. package/docs/reference/admin-ui-api/services/data-service.mdx +10 -10
  54. package/docs/reference/admin-ui-api/services/modal-service.mdx +5 -5
  55. package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx +1 -1
  56. package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +2 -2
  57. package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
  58. package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +1 -1
  59. package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +2 -2
  60. package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
  61. package/docs/reference/core-plugins/asset-server-plugin/index.mdx +1 -1
  62. package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +8 -8
  63. package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +1 -1
  64. package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +2 -2
  65. package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +1 -1
  66. package/docs/reference/core-plugins/dashboard-plugin/index.mdx +1 -1
  67. package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +8 -8
  68. package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
  69. package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +2 -2
  70. package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +13 -13
  71. package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
  72. package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
  73. package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +3 -3
  74. package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +1 -1
  75. package/docs/reference/core-plugins/email-plugin/email-sender.mdx +1 -1
  76. package/docs/reference/core-plugins/email-plugin/index.mdx +1 -1
  77. package/docs/reference/core-plugins/email-plugin/template-loader.mdx +4 -4
  78. package/docs/reference/core-plugins/email-plugin/transport-options.mdx +1 -1
  79. package/docs/reference/core-plugins/graphiql-plugin/index.mdx +2 -2
  80. package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -1
  81. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +9 -9
  82. package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +5 -5
  83. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +3 -3
  84. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx +1 -1
  85. package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx +2 -2
  86. package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx +1 -1
  87. package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +5 -5
  88. package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +4 -4
  89. package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx +1 -1
  90. package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx +1 -1
  91. package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +2 -2
  92. package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -1
  93. package/docs/reference/dashboard/components/asset-gallery.mdx +3 -3
  94. package/docs/reference/dashboard/components/asset-picker-dialog.mdx +2 -2
  95. package/docs/reference/dashboard/components/channel-chip.mdx +1 -1
  96. package/docs/reference/dashboard/components/detail-page-button.mdx +1 -1
  97. package/docs/reference/dashboard/components/facet-value-selector.mdx +1 -1
  98. package/docs/reference/dashboard/components/permission-guard.mdx +1 -1
  99. package/docs/reference/dashboard/components/vendure-image.mdx +2 -2
  100. package/docs/reference/dashboard/detail-views/detail-page.mdx +3 -3
  101. package/docs/reference/dashboard/detail-views/use-detail-page.mdx +11 -11
  102. package/docs/reference/dashboard/detail-views/use-generated-form.mdx +3 -3
  103. package/docs/reference/dashboard/extensions-api/action-bar.mdx +1 -1
  104. package/docs/reference/dashboard/extensions-api/alerts.mdx +6 -6
  105. package/docs/reference/dashboard/extensions-api/data-tables.mdx +1 -1
  106. package/docs/reference/dashboard/extensions-api/detail-forms.mdx +1 -1
  107. package/docs/reference/dashboard/extensions-api/history-entries.mdx +2 -2
  108. package/docs/reference/dashboard/extensions-api/page-blocks.mdx +2 -2
  109. package/docs/reference/dashboard/extensions-api/routes.mdx +4 -4
  110. package/docs/reference/dashboard/extensions-api/widgets.mdx +1 -1
  111. package/docs/reference/dashboard/form-components/affixed-input.mdx +1 -1
  112. package/docs/reference/dashboard/form-components/boolean-input.mdx +1 -1
  113. package/docs/reference/dashboard/form-components/checkbox-input.mdx +1 -1
  114. package/docs/reference/dashboard/form-components/date-time-input.mdx +1 -1
  115. package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
  116. package/docs/reference/dashboard/form-components/money-input.mdx +1 -1
  117. package/docs/reference/dashboard/form-components/number-input.mdx +1 -1
  118. package/docs/reference/dashboard/form-components/password-input.mdx +1 -1
  119. package/docs/reference/dashboard/form-components/rich-text-input.mdx +1 -1
  120. package/docs/reference/dashboard/form-components/textarea-input.mdx +1 -1
  121. package/docs/reference/dashboard/hooks/use-alerts.mdx +1 -1
  122. package/docs/reference/dashboard/hooks/use-auth.mdx +5 -5
  123. package/docs/reference/dashboard/hooks/use-channel.mdx +2 -2
  124. package/docs/reference/dashboard/hooks/use-drag-and-drop.mdx +1 -1
  125. package/docs/reference/dashboard/list-views/bulk-actions.mdx +3 -3
  126. package/docs/reference/dashboard/list-views/data-table.mdx +10 -10
  127. package/docs/reference/dashboard/list-views/list-page.mdx +13 -13
  128. package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +17 -17
  129. package/docs/reference/dashboard/page-layout/index.mdx +1 -1
  130. package/docs/reference/dashboard/page-layout/page-action-bar.mdx +3 -3
  131. package/docs/reference/dashboard/page-layout/page-block.mdx +3 -3
  132. package/docs/reference/dashboard/page-layout/page-title.mdx +1 -1
  133. package/docs/reference/dashboard/page-layout/page.mdx +3 -3
  134. package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
  135. package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +6 -6
  136. package/docs/reference/typescript-api/auth/auth-options.mdx +1 -1
  137. package/docs/reference/typescript-api/auth/authentication-strategy.mdx +2 -2
  138. package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +2 -2
  139. package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +4 -4
  140. package/docs/reference/typescript-api/auth/external-authentication-service.mdx +5 -5
  141. package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +3 -3
  142. package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +2 -2
  143. package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +1 -1
  144. package/docs/reference/typescript-api/auth/permission-definition.mdx +2 -2
  145. package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +4 -4
  146. package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +2 -2
  147. package/docs/reference/typescript-api/cache/cache-config.mdx +1 -1
  148. package/docs/reference/typescript-api/cache/cache-service.mdx +4 -4
  149. package/docs/reference/typescript-api/cache/cache-strategy.mdx +4 -4
  150. package/docs/reference/typescript-api/cache/index.mdx +3 -3
  151. package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +4 -4
  152. package/docs/reference/typescript-api/cache/request-context-cache-service.mdx +2 -2
  153. package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +6 -6
  154. package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +1 -1
  155. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx +1 -1
  156. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx +1 -1
  157. package/docs/reference/typescript-api/common/async-queue.mdx +1 -1
  158. package/docs/reference/typescript-api/common/bootstrap.mdx +2 -2
  159. package/docs/reference/typescript-api/common/injectable-strategy.mdx +2 -2
  160. package/docs/reference/typescript-api/common/injector.mdx +2 -2
  161. package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +1 -1
  162. package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx +11 -11
  163. package/docs/reference/typescript-api/configurable-operation-def/index.mdx +2 -2
  164. package/docs/reference/typescript-api/configuration/api-options.mdx +2 -2
  165. package/docs/reference/typescript-api/configuration/collection-filter.mdx +3 -3
  166. package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +6 -6
  167. package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +4 -4
  168. package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
  169. package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +1 -1
  170. package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +3 -3
  171. package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +15 -15
  172. package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
  173. package/docs/reference/typescript-api/configuration/vendure-config.mdx +2 -2
  174. package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +1 -1
  175. package/docs/reference/typescript-api/data-access/calculated.mdx +1 -1
  176. package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
  177. package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +1 -1
  178. package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
  179. package/docs/reference/typescript-api/data-access/list-query-builder.mdx +4 -4
  180. package/docs/reference/typescript-api/data-access/transactional-connection.mdx +9 -9
  181. package/docs/reference/typescript-api/default-search-plugin/index.mdx +1 -1
  182. package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +4 -4
  183. package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +4 -4
  184. package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +4 -4
  185. package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +4 -4
  186. package/docs/reference/typescript-api/entities/address.mdx +1 -1
  187. package/docs/reference/typescript-api/entities/administrator.mdx +1 -1
  188. package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
  189. package/docs/reference/typescript-api/entities/asset.mdx +1 -1
  190. package/docs/reference/typescript-api/entities/authenticated-session.mdx +1 -1
  191. package/docs/reference/typescript-api/entities/authentication-method.mdx +2 -2
  192. package/docs/reference/typescript-api/entities/channel.mdx +1 -1
  193. package/docs/reference/typescript-api/entities/collection.mdx +2 -2
  194. package/docs/reference/typescript-api/entities/country.mdx +1 -1
  195. package/docs/reference/typescript-api/entities/customer-group.mdx +1 -1
  196. package/docs/reference/typescript-api/entities/customer-history-entry.mdx +1 -1
  197. package/docs/reference/typescript-api/entities/customer.mdx +1 -1
  198. package/docs/reference/typescript-api/entities/facet-value.mdx +2 -2
  199. package/docs/reference/typescript-api/entities/facet.mdx +2 -2
  200. package/docs/reference/typescript-api/entities/fulfillment.mdx +1 -1
  201. package/docs/reference/typescript-api/entities/global-settings.mdx +1 -1
  202. package/docs/reference/typescript-api/entities/interfaces.mdx +1 -1
  203. package/docs/reference/typescript-api/entities/order-history-entry.mdx +1 -1
  204. package/docs/reference/typescript-api/entities/order-line-reference.mdx +3 -3
  205. package/docs/reference/typescript-api/entities/order-line.mdx +1 -1
  206. package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
  207. package/docs/reference/typescript-api/entities/order.mdx +1 -1
  208. package/docs/reference/typescript-api/entities/orderable-asset.mdx +1 -1
  209. package/docs/reference/typescript-api/entities/payment-method.mdx +2 -2
  210. package/docs/reference/typescript-api/entities/payment.mdx +1 -1
  211. package/docs/reference/typescript-api/entities/product-option-group.mdx +2 -2
  212. package/docs/reference/typescript-api/entities/product-option.mdx +2 -2
  213. package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -1
  214. package/docs/reference/typescript-api/entities/product-variant.mdx +2 -2
  215. package/docs/reference/typescript-api/entities/product.mdx +2 -2
  216. package/docs/reference/typescript-api/entities/promotion.mdx +4 -4
  217. package/docs/reference/typescript-api/entities/province.mdx +1 -1
  218. package/docs/reference/typescript-api/entities/refund.mdx +1 -1
  219. package/docs/reference/typescript-api/entities/region.mdx +1 -1
  220. package/docs/reference/typescript-api/entities/role.mdx +1 -1
  221. package/docs/reference/typescript-api/entities/seller.mdx +1 -1
  222. package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
  223. package/docs/reference/typescript-api/entities/shipping-line.mdx +1 -1
  224. package/docs/reference/typescript-api/entities/shipping-method.mdx +4 -4
  225. package/docs/reference/typescript-api/entities/stock-level.mdx +1 -1
  226. package/docs/reference/typescript-api/entities/stock-location.mdx +1 -1
  227. package/docs/reference/typescript-api/entities/stock-movement.mdx +5 -5
  228. package/docs/reference/typescript-api/entities/surcharge.mdx +1 -1
  229. package/docs/reference/typescript-api/entities/tag.mdx +1 -1
  230. package/docs/reference/typescript-api/entities/tax-category.mdx +1 -1
  231. package/docs/reference/typescript-api/entities/tax-rate.mdx +1 -1
  232. package/docs/reference/typescript-api/entities/user.mdx +1 -1
  233. package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -1
  234. package/docs/reference/typescript-api/entities/zone.mdx +1 -1
  235. package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +2 -2
  236. package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx +2 -2
  237. package/docs/reference/typescript-api/events/event-bus.mdx +4 -4
  238. package/docs/reference/typescript-api/events/event-types.mdx +30 -30
  239. package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +5 -5
  240. package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +4 -4
  241. package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +1 -1
  242. package/docs/reference/typescript-api/import-export/asset-importer.mdx +1 -1
  243. package/docs/reference/typescript-api/import-export/fast-importer-service.mdx +4 -4
  244. package/docs/reference/typescript-api/import-export/import-parser.mdx +5 -5
  245. package/docs/reference/typescript-api/import-export/importer.mdx +3 -3
  246. package/docs/reference/typescript-api/import-export/initial-data.mdx +3 -3
  247. package/docs/reference/typescript-api/import-export/populate.mdx +1 -1
  248. package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -5
  249. package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +3 -3
  250. package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +8 -8
  251. package/docs/reference/typescript-api/job-queue/index.mdx +2 -2
  252. package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +5 -5
  253. package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +3 -3
  254. package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
  255. package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +6 -6
  256. package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +3 -3
  257. package/docs/reference/typescript-api/job-queue/job.mdx +3 -3
  258. package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +8 -8
  259. package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +6 -6
  260. package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +3 -3
  261. package/docs/reference/typescript-api/job-queue/types.mdx +1 -1
  262. package/docs/reference/typescript-api/migration/generate-migration.mdx +1 -1
  263. package/docs/reference/typescript-api/migration/revert-last-migration.mdx +1 -1
  264. package/docs/reference/typescript-api/migration/run-migrations.mdx +1 -1
  265. package/docs/reference/typescript-api/orders/active-order-service.mdx +6 -6
  266. package/docs/reference/typescript-api/orders/active-order-strategy.mdx +3 -3
  267. package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +1 -1
  268. package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +1 -1
  269. package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +1 -1
  270. package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -1
  271. package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
  272. package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +1 -1
  273. package/docs/reference/typescript-api/orders/order-code-strategy.mdx +1 -1
  274. package/docs/reference/typescript-api/orders/order-interceptor.mdx +3 -3
  275. package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +1 -1
  276. package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
  277. package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
  278. package/docs/reference/typescript-api/orders/order-process.mdx +4 -4
  279. package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +3 -3
  280. package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
  281. package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +6 -6
  282. package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +4 -4
  283. package/docs/reference/typescript-api/payment/payment-method-handler.mdx +2 -2
  284. package/docs/reference/typescript-api/payment/payment-method-types.mdx +3 -3
  285. package/docs/reference/typescript-api/payment/payment-options.mdx +3 -3
  286. package/docs/reference/typescript-api/payment/payment-process.mdx +4 -4
  287. package/docs/reference/typescript-api/payment/refund-process.mdx +4 -4
  288. package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +4 -4
  289. package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
  290. package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
  291. package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +1 -1
  292. package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -2
  293. package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +1 -1
  294. package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
  295. package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +5 -5
  296. package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +1 -1
  297. package/docs/reference/typescript-api/promotions/promotion-action.mdx +22 -22
  298. package/docs/reference/typescript-api/promotions/promotion-condition.mdx +5 -5
  299. package/docs/reference/typescript-api/promotions/promotion-options.mdx +2 -2
  300. package/docs/reference/typescript-api/request/request-context-service.mdx +2 -2
  301. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +4 -4
  302. package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +4 -4
  303. package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +3 -3
  304. package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +5 -5
  305. package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +1 -1
  306. package/docs/reference/typescript-api/service-helpers/order-calculator.mdx +1 -1
  307. package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +3 -3
  308. package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -1
  309. package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +2 -2
  310. package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +2 -2
  311. package/docs/reference/typescript-api/service-helpers/translator-service.mdx +1 -1
  312. package/docs/reference/typescript-api/services/administrator-service.mdx +6 -6
  313. package/docs/reference/typescript-api/services/asset-service.mdx +13 -13
  314. package/docs/reference/typescript-api/services/auth-service.mdx +4 -4
  315. package/docs/reference/typescript-api/services/channel-service.mdx +12 -12
  316. package/docs/reference/typescript-api/services/collection-service.mdx +20 -20
  317. package/docs/reference/typescript-api/services/country-service.mdx +7 -7
  318. package/docs/reference/typescript-api/services/customer-group-service.mdx +8 -8
  319. package/docs/reference/typescript-api/services/customer-service.mdx +24 -24
  320. package/docs/reference/typescript-api/services/entity-slug-service.mdx +1 -1
  321. package/docs/reference/typescript-api/services/facet-service.mdx +11 -11
  322. package/docs/reference/typescript-api/services/facet-value-service.mdx +12 -12
  323. package/docs/reference/typescript-api/services/fulfillment-service.mdx +4 -4
  324. package/docs/reference/typescript-api/services/global-settings-service.mdx +2 -2
  325. package/docs/reference/typescript-api/services/history-service.mdx +8 -8
  326. package/docs/reference/typescript-api/services/order-service.mdx +52 -52
  327. package/docs/reference/typescript-api/services/order-testing-service.mdx +2 -2
  328. package/docs/reference/typescript-api/services/payment-method-service.mdx +10 -10
  329. package/docs/reference/typescript-api/services/payment-service.mdx +7 -7
  330. package/docs/reference/typescript-api/services/product-option-group-service.mdx +5 -5
  331. package/docs/reference/typescript-api/services/product-option-service.mdx +5 -5
  332. package/docs/reference/typescript-api/services/product-service.mdx +13 -13
  333. package/docs/reference/typescript-api/services/product-variant-service.mdx +22 -22
  334. package/docs/reference/typescript-api/services/promotion-service.mdx +9 -9
  335. package/docs/reference/typescript-api/services/province-service.mdx +5 -5
  336. package/docs/reference/typescript-api/services/role-service.mdx +11 -11
  337. package/docs/reference/typescript-api/services/search-service.mdx +2 -2
  338. package/docs/reference/typescript-api/services/seller-service.mdx +3 -3
  339. package/docs/reference/typescript-api/services/session-service.mdx +8 -8
  340. package/docs/reference/typescript-api/services/settings-store-service.mdx +15 -15
  341. package/docs/reference/typescript-api/services/shipping-method-service.mdx +8 -8
  342. package/docs/reference/typescript-api/services/slug-service.mdx +1 -1
  343. package/docs/reference/typescript-api/services/stock-level-service.mdx +3 -3
  344. package/docs/reference/typescript-api/services/stock-location-service.mdx +7 -7
  345. package/docs/reference/typescript-api/services/stock-movement-service.mdx +7 -7
  346. package/docs/reference/typescript-api/services/tag-service.mdx +5 -5
  347. package/docs/reference/typescript-api/services/tax-category-service.mdx +5 -5
  348. package/docs/reference/typescript-api/services/tax-rate-service.mdx +6 -6
  349. package/docs/reference/typescript-api/services/user-service.mdx +12 -12
  350. package/docs/reference/typescript-api/services/zone-service.mdx +8 -8
  351. package/docs/reference/typescript-api/settings-store/settings-store-field-config.mdx +2 -2
  352. package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +1 -1
  353. package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +3 -3
  354. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +3 -3
  355. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +2 -2
  356. package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +1 -1
  357. package/docs/reference/typescript-api/shipping/shipping-options.mdx +5 -5
  358. package/docs/reference/typescript-api/state-machine/fsm.mdx +2 -2
  359. package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +4 -4
  360. package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +1 -1
  361. package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +1 -1
  362. package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +2 -2
  363. package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -1
  364. package/docs/reference/typescript-api/testing/create-test-environment.mdx +1 -1
  365. package/docs/reference/typescript-api/testing/error-result-guard.mdx +1 -1
  366. package/docs/reference/typescript-api/testing/register-initializer.mdx +1 -1
  367. package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx +5 -5
  368. package/docs/reference/typescript-api/testing/test-db-initializer.mdx +3 -3
  369. package/docs/reference/typescript-api/testing/test-server.mdx +2 -2
  370. package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
  371. package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -2
  372. package/docs/reference/typescript-api/worker/vendure-worker.mdx +2 -2
  373. package/package.json +2 -2
  374. package/docs/reference/admin-ui-api/index.mdx +0 -4
  375. package/docs/reference/dashboard/index.mdx +0 -4
  376. package/docs/reference/graphql-api/admin/_index.mdx +0 -4
  377. package/docs/reference/graphql-api/shop/_index.mdx +0 -4
  378. package/docs/reference/typescript-api/_index.mdx +0 -4
@@ -156,18 +156,18 @@ class EmailEventHandler<T extends string = string, Event extends EventWithContex
156
156
 
157
157
  ### constructor
158
158
 
159
- <MemberInfo kind="method" type={`(listener: <a href='/reference/core-plugins/email-plugin/email-event-listener#emaileventlistener'>EmailEventListener</a>&#60;T&#62;, event: Type&#60;Event&#62;) => EmailEventHandler`} />
159
+ <MemberInfo kind="method" type={`(listener: <a href='/reference/core-plugins/email-plugin/email-event-listener#emaileventlistener'>EmailEventListener</a><T>, event: Type<Event>) => EmailEventHandler`} />
160
160
 
161
161
 
162
162
  ### filter
163
163
 
164
- <MemberInfo kind="method" type={`(filterFn: (event: Event) =&#62; boolean) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>&#60;T, Event&#62;`} />
164
+ <MemberInfo kind="method" type={`(filterFn: (event: Event) => boolean) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
165
165
 
166
166
  Defines a predicate function which is used to determine whether the event will trigger an email.
167
167
  Multiple filter functions may be defined.
168
168
  ### setRecipient
169
169
 
170
- <MemberInfo kind="method" type={`(setRecipientFn: (event: Event) =&#62; string) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>&#60;T, Event&#62;`} />
170
+ <MemberInfo kind="method" type={`(setRecipientFn: (event: Event) => string) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
171
171
 
172
172
  A function which defines how the recipient email address should be extracted from the incoming event.
173
173
 
@@ -176,35 +176,35 @@ Or with a formatted name (includes unicode support): `'Ноде Майлер <fo
176
176
  Or a comma-separated list of addresses: `'foobar@example.com, "Ноде Майлер" <bar@example.com>'`
177
177
  ### setLanguageCode
178
178
 
179
- <MemberInfo kind="method" type={`(setLanguageCodeFn: (event: Event) =&#62; <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a> | undefined) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>&#60;T, Event&#62;`} since="1.8.0" />
179
+ <MemberInfo kind="method" type={`(setLanguageCodeFn: (event: Event) => <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a> | undefined) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} since="1.8.0" />
180
180
 
181
181
  A function which allows to override the language of the email. If not defined, the language from the context will be used.
182
182
  ### setTemplateVars
183
183
 
184
- <MemberInfo kind="method" type={`(templateVarsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#settemplatevarsfn'>SetTemplateVarsFn</a>&#60;Event&#62;) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>&#60;T, Event&#62;`} />
184
+ <MemberInfo kind="method" type={`(templateVarsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#settemplatevarsfn'>SetTemplateVarsFn</a><Event>) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
185
185
 
186
186
  A function which returns an object hash of variables which will be made available to the Handlebars template
187
187
  and subject line for interpolation.
188
188
  ### setSubject
189
189
 
190
- <MemberInfo kind="method" type={`(defaultSubject: string | <a href='/reference/core-plugins/email-plugin/email-plugin-types#setsubjectfn'>SetSubjectFn</a>&#60;Event&#62;) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>&#60;T, Event&#62;`} />
190
+ <MemberInfo kind="method" type={`(defaultSubject: string | <a href='/reference/core-plugins/email-plugin/email-plugin-types#setsubjectfn'>SetSubjectFn</a><Event>) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
191
191
 
192
192
  Sets the default subject of the email. The subject string may use Handlebars variables defined by the
193
193
  setTemplateVars() method.
194
194
  ### setFrom
195
195
 
196
- <MemberInfo kind="method" type={`(from: string) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>&#60;T, Event&#62;`} />
196
+ <MemberInfo kind="method" type={`(from: string) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
197
197
 
198
198
  Sets the default from field of the email. The from string may use Handlebars variables defined by the
199
199
  setTemplateVars() method.
200
200
  ### setOptionalAddressFields
201
201
 
202
- <MemberInfo kind="method" type={`(optionalAddressFieldsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setoptionaladdressfieldsfn'>SetOptionalAddressFieldsFn</a>&#60;Event&#62;) => `} since="1.1.0" />
202
+ <MemberInfo kind="method" type={`(optionalAddressFieldsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setoptionaladdressfieldsfn'>SetOptionalAddressFieldsFn</a><Event>) => `} since="1.1.0" />
203
203
 
204
204
  A function which allows <a href='/reference/core-plugins/email-plugin/email-plugin-types#optionaladdressfields'>OptionalAddressFields</a> to be specified such as "cc" and "bcc".
205
205
  ### setMetadata
206
206
 
207
- <MemberInfo kind="method" type={`(optionalSetMetadataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setmetadatafn'>SetMetadataFn</a>&#60;Event&#62;) => `} since="3.1.0" />
207
+ <MemberInfo kind="method" type={`(optionalSetMetadataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setmetadatafn'>SetMetadataFn</a><Event>) => `} since="3.1.0" />
208
208
 
209
209
  A function which allows <a href='/reference/core-plugins/email-plugin/email-plugin-types#emailmetadata'>EmailMetadata</a> to be specified for the email. This can be used
210
210
  to store arbitrary data about the email which can be used for tracking or other purposes.
@@ -229,7 +229,7 @@ It will be exposed in the <a href='/reference/core-plugins/email-plugin/email-se
229
229
  the order in another available way.
230
230
  ### setAttachments
231
231
 
232
- <MemberInfo kind="method" type={`(setAttachmentsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setattachmentsfn'>SetAttachmentsFn</a>&#60;Event&#62;) => `} />
232
+ <MemberInfo kind="method" type={`(setAttachmentsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setattachmentsfn'>SetAttachmentsFn</a><Event>) => `} />
233
233
 
234
234
  Defines one or more files to be attached to the email. An attachment can be specified
235
235
  as either a `path` (to a file or URL) or as `content` which can be a string, Buffer or Stream.
@@ -257,13 +257,13 @@ const testAttachmentHandler = new EmailEventListener('activate-voucher')
257
257
  ```
258
258
  ### addTemplate
259
259
 
260
- <MemberInfo kind="method" type={`(config: EmailTemplateConfig) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>&#60;T, Event&#62;`} />
260
+ <MemberInfo kind="method" type={`(config: EmailTemplateConfig) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
261
261
 
262
262
  Add configuration for another template other than the default `"body.hbs"`. Use this method to define specific
263
263
  templates for channels or languageCodes other than the default.
264
264
  ### loadData
265
265
 
266
- <MemberInfo kind="method" type={`(loadDataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loaddatafn'>LoadDataFn</a>&#60;Event, R&#62;) => <a href='/reference/core-plugins/email-plugin/email-event-handler-with-async-data#emaileventhandlerwithasyncdata'>EmailEventHandlerWithAsyncData</a>&#60;R, T, Event, <a href='/reference/core-plugins/email-plugin/email-plugin-types#eventwithasyncdata'>EventWithAsyncData</a>&#60;Event, R&#62;&#62;`} />
266
+ <MemberInfo kind="method" type={`(loadDataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loaddatafn'>LoadDataFn</a><Event, R>) => <a href='/reference/core-plugins/email-plugin/email-event-handler-with-async-data#emaileventhandlerwithasyncdata'>EmailEventHandlerWithAsyncData</a><R, T, Event, <a href='/reference/core-plugins/email-plugin/email-plugin-types#eventwithasyncdata'>EventWithAsyncData</a><Event, R>>`} />
267
267
 
268
268
  Allows data to be loaded asynchronously which can then be used as template variables.
269
269
  The `loadDataFn` has access to the event, the TypeORM `Connection` object, and an
@@ -289,7 +289,7 @@ new EmailEventListener('order-confirmation')
289
289
  ```
290
290
  ### setMockEvent
291
291
 
292
- <MemberInfo kind="method" type={`(event: Omit&#60;Event, 'ctx' | 'data'&#62;) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>&#60;T, Event&#62;`} />
292
+ <MemberInfo kind="method" type={`(event: Omit<Event, 'ctx' | 'data'>) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
293
293
 
294
294
  Optionally define a mock Event which is used by the dev mode mailbox app for generating mock emails
295
295
  from this handler, which is useful when developing the email templates.
@@ -33,7 +33,7 @@ class EmailEventListener<T extends string> {
33
33
 
34
34
  ### on
35
35
 
36
- <MemberInfo kind="method" type={`(event: Type&#60;Event&#62;) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>&#60;T, Event&#62;`} />
36
+ <MemberInfo kind="method" type={`(event: Type<Event>) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
37
37
 
38
38
  Defines the event to listen for.
39
39
 
@@ -29,12 +29,12 @@ interface EmailGenerator<T extends string = any, E extends VendureEvent = any> e
29
29
 
30
30
  ### onInit
31
31
 
32
- <MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/email-plugin/email-plugin-options#emailpluginoptions'>EmailPluginOptions</a>) => void | Promise&#60;void&#62;`} />
32
+ <MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/email-plugin/email-plugin-options#emailpluginoptions'>EmailPluginOptions</a>) => void | Promise<void>`} />
33
33
 
34
34
  Any necessary setup can be performed here.
35
35
  ### generate
36
36
 
37
- <MemberInfo kind="method" type={`(from: string, subject: string, body: string, templateVars: { [key: string]: any }) => Pick&#60;<a href='/reference/core-plugins/email-plugin/email-plugin-types#emaildetails'>EmailDetails</a>, 'from' | 'subject' | 'body'&#62;`} />
37
+ <MemberInfo kind="method" type={`(from: string, subject: string, body: string, templateVars: { [key: string]: any }) => Pick<<a href='/reference/core-plugins/email-plugin/email-plugin-types#emaildetails'>EmailDetails</a>, 'from' | 'subject' | 'body'>`} />
38
38
 
39
39
  Given a subject and body from an email template, this method generates the final
40
40
  interpolated email text.
@@ -43,12 +43,12 @@ An optional TemplateLoader which can be used to load templates from a custom loc
43
43
  The default uses the FileBasedTemplateLoader which loads templates from `<project root>/vendure/email/templates`
44
44
  ### transport
45
45
 
46
- <MemberInfo kind="property" type={`| <a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a> | (( injector?: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, ) =&#62; <a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a> | Promise&#60;<a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a>&#62;)`} />
46
+ <MemberInfo kind="property" type={`| <a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a> | (( injector?: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, ) => <a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a> | Promise<<a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a>>)`} />
47
47
 
48
48
  Configures how the emails are sent.
49
49
  ### handlers
50
50
 
51
- <MemberInfo kind="property" type={`Array&#60;<a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>&#60;string, any&#62;&#62;`} />
51
+ <MemberInfo kind="property" type={`Array<<a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><string, any>>`} />
52
52
 
53
53
  An array of <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>s which define which Vendure events will trigger
54
54
  emails, and how those emails are generated.
@@ -127,7 +127,7 @@ interface EmailPluginDevModeOptions extends Omit<EmailPluginOptions, 'transport'
127
127
  route: string;
128
128
  }
129
129
  ```
130
- * Extends: <code>Omit&#60;<a href='/reference/core-plugins/email-plugin/email-plugin-options#emailpluginoptions'>EmailPluginOptions</a>, 'transport'&#62;</code>
130
+ * Extends: <code>Omit<<a href='/reference/core-plugins/email-plugin/email-plugin-options#emailpluginoptions'>EmailPluginOptions</a>, 'transport'></code>
131
131
 
132
132
 
133
133
 
@@ -72,7 +72,7 @@ interface EmailDetails<Type extends 'serialized' | 'unserialized' = 'unserialize
72
72
 
73
73
  ### attachments
74
74
 
75
- <MemberInfo kind="property" type={`Array&#60;Type extends 'serialized' ? SerializedAttachment : Attachment&#62;`} />
75
+ <MemberInfo kind="property" type={`Array<Type extends 'serialized' ? SerializedAttachment : Attachment>`} />
76
76
 
77
77
 
78
78
  ### cc
@@ -56,7 +56,7 @@ interface EmailSender extends InjectableStrategy {
56
56
 
57
57
  ### send
58
58
 
59
- <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;`} />
59
+ <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>`} />
60
60
 
61
61
 
62
62
 
@@ -290,7 +290,7 @@ class EmailPlugin implements OnApplicationBootstrap, OnApplicationShutdown, Nest
290
290
 
291
291
  ### init
292
292
 
293
- <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;`} />
293
+ <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>>`} />
294
294
 
295
295
 
296
296
  ### onApplicationShutdown
@@ -41,12 +41,12 @@ interface TemplateLoader {
41
41
 
42
42
  ### loadTemplate
43
43
 
44
- <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;`} />
44
+ <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>`} />
45
45
 
46
46
  Load template and return it's content as a string
47
47
  ### loadPartials
48
48
 
49
- <MemberInfo kind="method" type={`() => Promise&#60;Partial[]&#62;`} />
49
+ <MemberInfo kind="method" type={`() => Promise<Partial[]>`} />
50
50
 
51
51
  Load partials and return their contents.
52
52
  This method is only called during initialization, i.e. during server startup.
@@ -82,12 +82,12 @@ class FileBasedTemplateLoader implements TemplateLoader {
82
82
 
83
83
  ### loadTemplate
84
84
 
85
- <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;`} />
85
+ <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>`} />
86
86
 
87
87
 
88
88
  ### loadPartials
89
89
 
90
- <MemberInfo kind="method" type={`() => Promise&#60;Partial[]&#62;`} />
90
+ <MemberInfo kind="method" type={`() => Promise<Partial[]>`} />
91
91
 
92
92
 
93
93
 
@@ -232,7 +232,7 @@ interface TestingTransportOptions {
232
232
 
233
233
  ### onSend
234
234
 
235
- <MemberInfo kind="property" type={`(details: <a href='/reference/core-plugins/email-plugin/email-plugin-types#emaildetails'>EmailDetails</a>) =&#62; void`} />
235
+ <MemberInfo kind="property" type={`(details: <a href='/reference/core-plugins/email-plugin/email-plugin-types#emaildetails'>EmailDetails</a>) => void`} />
236
236
 
237
237
  Callback to be invoked when an email would be sent.
238
238
 
@@ -65,7 +65,7 @@ class GraphiqlPlugin implements NestModule {
65
65
 
66
66
  ### options
67
67
 
68
- <MemberInfo kind="property" type={`Required&#60;GraphiqlPluginOptions&#62;`} />
68
+ <MemberInfo kind="property" type={`Required<GraphiqlPluginOptions>`} />
69
69
 
70
70
 
71
71
  ### constructor
@@ -75,7 +75,7 @@ class GraphiqlPlugin implements NestModule {
75
75
 
76
76
  ### init
77
77
 
78
- <MemberInfo kind="method" type={`(options: GraphiqlPluginOptions = {}) => Type&#60;<a href='/reference/core-plugins/graphiql-plugin/#graphiqlplugin'>GraphiqlPlugin</a>&#62;`} />
78
+ <MemberInfo kind="method" type={`(options: GraphiqlPluginOptions = {}) => Type<<a href='/reference/core-plugins/graphiql-plugin/#graphiqlplugin'>GraphiqlPlugin</a>>`} />
79
79
 
80
80
 
81
81
  ### configure
@@ -89,7 +89,7 @@ When set to `'prod'`, the plugin will disable dev-mode features of the GraphQL A
89
89
  - GraphQL playground
90
90
  ### skip
91
91
 
92
- <MemberInfo kind="property" type={`(context: GraphQLRequestContext&#60;any&#62;) =&#62; Promise&#60;boolean&#62; | boolean`} />
92
+ <MemberInfo kind="property" type={`(context: GraphQLRequestContext<any>) => Promise<boolean> | boolean`} />
93
93
 
94
94
  Allows you to skip the complexity check for certain requests.
95
95
 
@@ -39,7 +39,7 @@ class BullMQJobQueueStrategy implements InspectableJobQueueStrategy {
39
39
 
40
40
  ### init
41
41
 
42
- <MemberInfo kind="method" type={`(injector: Injector) => Promise&#60;void&#62;`} />
42
+ <MemberInfo kind="method" type={`(injector: Injector) => Promise<void>`} />
43
43
 
44
44
 
45
45
  ### destroy
@@ -49,42 +49,42 @@ class BullMQJobQueueStrategy implements InspectableJobQueueStrategy {
49
49
 
50
50
  ### add
51
51
 
52
- <MemberInfo kind="method" type={`(job: Job&#60;Data&#62;) => Promise&#60;Job&#60;Data&#62;&#62;`} />
52
+ <MemberInfo kind="method" type={`(job: Job<Data>) => Promise<Job<Data>>`} />
53
53
 
54
54
 
55
55
  ### cancelJob
56
56
 
57
- <MemberInfo kind="method" type={`(jobId: string) => Promise&#60;Job | undefined&#62;`} />
57
+ <MemberInfo kind="method" type={`(jobId: string) => Promise<Job | undefined>`} />
58
58
 
59
59
 
60
60
  ### findMany
61
61
 
62
- <MemberInfo kind="method" type={`(options?: JobListOptions) => Promise&#60;PaginatedList&#60;Job&#62;&#62;`} />
62
+ <MemberInfo kind="method" type={`(options?: JobListOptions) => Promise<PaginatedList<Job>>`} />
63
63
 
64
64
 
65
65
  ### findManyById
66
66
 
67
- <MemberInfo kind="method" type={`(ids: ID[]) => Promise&#60;Job[]&#62;`} />
67
+ <MemberInfo kind="method" type={`(ids: ID[]) => Promise<Job[]>`} />
68
68
 
69
69
 
70
70
  ### findOne
71
71
 
72
- <MemberInfo kind="method" type={`(id: ID) => Promise&#60;Job | undefined&#62;`} />
72
+ <MemberInfo kind="method" type={`(id: ID) => Promise<Job | undefined>`} />
73
73
 
74
74
 
75
75
  ### removeSettledJobs
76
76
 
77
- <MemberInfo kind="method" type={`(queueNames?: string[], olderThan?: Date) => Promise&#60;number&#62;`} />
77
+ <MemberInfo kind="method" type={`(queueNames?: string[], olderThan?: Date) => Promise<number>`} />
78
78
 
79
79
 
80
80
  ### start
81
81
 
82
- <MemberInfo kind="method" type={`(queueName: string, process: (job: Job&#60;Data&#62;) =&#62; Promise&#60;any&#62;) => Promise&#60;void&#62;`} />
82
+ <MemberInfo kind="method" type={`(queueName: string, process: (job: Job<Data>) => Promise<any>) => Promise<void>`} />
83
83
 
84
84
 
85
85
  ### stop
86
86
 
87
- <MemberInfo kind="method" type={`(queueName: string, process: (job: Job&#60;Data&#62;) =&#62; Promise&#60;any&#62;) => Promise&#60;void&#62;`} />
87
+ <MemberInfo kind="method" type={`(queueName: string, process: (job: Job<Data>) => Promise<any>) => Promise<void>`} />
88
88
 
89
89
 
90
90
 
@@ -33,21 +33,21 @@ creating a new Queue, Worker and Scheduler instance.
33
33
  If omitted, it will attempt to connect to Redis at `127.0.0.1:6379`.
34
34
  ### queueOptions
35
35
 
36
- <MemberInfo kind="property" type={`Omit&#60;QueueOptions, 'connection'&#62;`} />
36
+ <MemberInfo kind="property" type={`Omit<QueueOptions, 'connection'>`} />
37
37
 
38
38
  Additional options used when instantiating the BullMQ
39
39
  Queue instance.
40
40
  See the [BullMQ QueueOptions docs](https://github.com/taskforcesh/bullmq/blob/master/docs/gitbook/api/bullmq.queueoptions.md)
41
41
  ### workerOptions
42
42
 
43
- <MemberInfo kind="property" type={`Omit&#60;WorkerOptions, 'connection'&#62;`} />
43
+ <MemberInfo kind="property" type={`Omit<WorkerOptions, 'connection'>`} />
44
44
 
45
45
  Additional options used when instantiating the BullMQ
46
46
  Worker instance.
47
47
  See the [BullMQ WorkerOptions docs](https://github.com/taskforcesh/bullmq/blob/master/docs/gitbook/api/bullmq.workeroptions.md)
48
48
  ### setRetries
49
49
 
50
- <MemberInfo kind="property" type={`(queueName: string, job: Job) =&#62; number`} since="1.3.0" />
50
+ <MemberInfo kind="property" type={`(queueName: string, job: Job) => number`} since="1.3.0" />
51
51
 
52
52
  When a job is added to the JobQueue using `JobQueue.add()`, the calling
53
53
  code may specify the number of retries in case of failure. This option allows
@@ -69,7 +69,7 @@ setRetries: (queueName, job) => {
69
69
  ```
70
70
  ### setBackoff
71
71
 
72
- <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" />
72
+ <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" />
73
73
 
74
74
  This allows you to specify the backoff settings when a failed job gets retried.
75
75
  In other words, this determines how much time should pass before attempting to
@@ -88,7 +88,7 @@ setBackoff: (queueName, job) => {
88
88
  ```
89
89
  ### setJobOptions
90
90
 
91
- <MemberInfo kind="property" type={`(queueName: string, job: Job) =&#62; BullJobsOptions`} since="3.2.0" />
91
+ <MemberInfo kind="property" type={`(queueName: string, job: Job) => BullJobsOptions`} since="3.2.0" />
92
92
 
93
93
  This allows you to specify additional options for a job when it is added to the queue.
94
94
  The object returned is the BullMQ [JobsOptions](https://api.docs.bullmq.io/types/v5.JobsOptions.html)
@@ -46,17 +46,17 @@ class PubSubJobQueueStrategy extends InjectableJobQueueStrategy implements JobQu
46
46
 
47
47
  ### add
48
48
 
49
- <MemberInfo kind="method" type={`(job: Job&#60;Data&#62;) => Promise&#60;Job&#60;Data&#62;&#62;`} />
49
+ <MemberInfo kind="method" type={`(job: Job<Data>) => Promise<Job<Data>>`} />
50
50
 
51
51
 
52
52
  ### start
53
53
 
54
- <MemberInfo kind="method" type={`(queueName: string, process: (job: Job&#60;Data&#62;) =&#62; Promise&#60;any&#62;) => `} />
54
+ <MemberInfo kind="method" type={`(queueName: string, process: (job: Job<Data>) => Promise<any>) => `} />
55
55
 
56
56
 
57
57
  ### stop
58
58
 
59
- <MemberInfo kind="method" type={`(queueName: string, process: (job: Job&#60;Data&#62;) =&#62; Promise&#60;any&#62;) => `} />
59
+ <MemberInfo kind="method" type={`(queueName: string, process: (job: Job<Data>) => Promise<any>) => `} />
60
60
 
61
61
 
62
62
 
@@ -27,7 +27,7 @@ class PubSubPlugin {
27
27
 
28
28
  ### init
29
29
 
30
- <MemberInfo kind="method" type={`(options: PubSubOptions) => Type&#60;<a href='/reference/core-plugins/job-queue-plugin/pub-sub-plugin#pubsubplugin'>PubSubPlugin</a>&#62;`} />
30
+ <MemberInfo kind="method" type={`(options: PubSubOptions) => Type<<a href='/reference/core-plugins/job-queue-plugin/pub-sub-plugin#pubsubplugin'>PubSubPlugin</a>>`} />
31
31
 
32
32
 
33
33
 
@@ -251,7 +251,7 @@ class BraintreePlugin {
251
251
 
252
252
  ### init
253
253
 
254
- <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;`} />
254
+ <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>>`} />
255
255
 
256
256
 
257
257
 
@@ -293,7 +293,7 @@ Since v1.8, it is possible to override vaulting on a per-payment basis by passin
293
293
  `generateBraintreeClientToken` mutation.
294
294
  ### extractMetadata
295
295
 
296
- <MemberInfo kind="property" type={`(transaction: <a href='/reference/typescript-api/request/transaction-decorator#transaction'>Transaction</a>) =&#62; PaymentMetadata`} since="1.7.0" />
296
+ <MemberInfo kind="property" type={`(transaction: <a href='/reference/typescript-api/request/transaction-decorator#transaction'>Transaction</a>) => PaymentMetadata`} since="1.7.0" />
297
297
 
298
298
  Allows you to configure exactly what information from the Braintree
299
299
  [Transaction object](https://developer.paypal.com/braintree/docs/reference/response/transaction#result-object) (which is returned by the
@@ -169,7 +169,7 @@ The host of your Vendure server, e.g. `'https://my-vendure.io'`.
169
169
  This is used by Mollie to send webhook events to the Vendure server
170
170
  ### enabledPaymentMethodsParams
171
171
 
172
- <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" />
172
+ <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" />
173
173
 
174
174
  Provide additional parameters to the Mollie enabled payment methods API call. By default,
175
175
  the plugin will already pass the `resource` parameter.
@@ -167,7 +167,7 @@ class StripePlugin {
167
167
 
168
168
  ### init
169
169
 
170
- <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;`} />
170
+ <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>>`} />
171
171
 
172
172
  Initialize the Stripe payment plugin
173
173
 
@@ -220,7 +220,7 @@ to be used with the same PaymentIntent. This is done by adding a custom field to
220
220
  the Stripe customer ID, so switching this on will require a database migration / synchronization.
221
221
  ### metadata
222
222
 
223
- <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" />
223
+ <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" />
224
224
 
225
225
  Attach extra metadata to Stripe payment intent creation call.
226
226
 
@@ -250,7 +250,7 @@ Note: If the `paymentIntentCreateParams` is also used and returns a `metadata` k
250
250
  returned by both functions will be merged.
251
251
  ### paymentIntentCreateParams
252
252
 
253
- <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" />
253
+ <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" />
254
254
 
255
255
  Provide additional parameters to the Stripe payment intent creation. By default,
256
256
  the plugin will already pass the `amount`, `currency`, `customer` and `automatic_payment_methods: { enabled: true }` parameters.
@@ -278,7 +278,7 @@ export const config: VendureConfig = {
278
278
  ```
279
279
  ### requestOptions
280
280
 
281
- <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" />
281
+ <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" />
282
282
 
283
283
  Provide additional options to the Stripe payment intent creation. By default,
284
284
  the plugin will already pass the `idempotencyKey` parameter.
@@ -306,7 +306,7 @@ export const config: VendureConfig = {
306
306
  ```
307
307
  ### customerCreateParams
308
308
 
309
- <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" />
309
+ <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" />
310
310
 
311
311
  Provide additional parameters to the Stripe customer creation. By default,
312
312
  the plugin will already pass the `email` and `name` parameters.
@@ -25,7 +25,7 @@ class PurgeRule<Event extends VendureEvent = VendureEvent> {
25
25
 
26
26
  ### eventType
27
27
 
28
- <MemberInfo kind="property" type={`Type&#60;Event&#62;`} />
28
+ <MemberInfo kind="property" type={`Type<Event>`} />
29
29
 
30
30
 
31
31
  ### bufferTimeMs
@@ -40,7 +40,7 @@ class PurgeRule<Event extends VendureEvent = VendureEvent> {
40
40
 
41
41
  ### constructor
42
42
 
43
- <MemberInfo kind="method" type={`(config: <a href='/reference/core-plugins/stellate-plugin/purge-rule#purgeruleconfig'>PurgeRuleConfig</a>&#60;Event&#62;) => PurgeRule`} />
43
+ <MemberInfo kind="method" type={`(config: <a href='/reference/core-plugins/stellate-plugin/purge-rule#purgeruleconfig'>PurgeRuleConfig</a><Event>) => PurgeRule`} />
44
44
 
45
45
 
46
46
 
@@ -70,7 +70,7 @@ interface PurgeRuleConfig<Event extends VendureEvent> {
70
70
 
71
71
  ### eventType
72
72
 
73
- <MemberInfo kind="property" type={`Type&#60;Event&#62;`} />
73
+ <MemberInfo kind="property" type={`Type<Event>`} />
74
74
 
75
75
  Specifies which VendureEvent will trigger this purge rule.
76
76
  ### bufferTime
@@ -81,7 +81,7 @@ How long to buffer events for in milliseconds before executing the handler. This
81
81
  us to efficiently batch calls to the Stellate Purge API.
82
82
  ### handler
83
83
 
84
- <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;`} />
84
+ <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>`} />
85
85
 
86
86
  The function to invoke when the specified event is published. This function should use the
87
87
  <a href='/reference/core-plugins/stellate-plugin/stellate-service#stellateservice'>StellateService</a> instance to call the Stellate Purge API.
@@ -42,7 +42,7 @@ Purges the cache for the given Products.
42
42
  Purges the cache for the given ProductVariants.
43
43
  ### purgeSearchResults
44
44
 
45
- <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;) => `} />
45
+ <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>>) => `} />
46
46
 
47
47
  Purges the cache for SearchResults which contain the given Products or ProductVariants.
48
48
  ### purgeAllOfType
@@ -83,7 +83,7 @@ When set to `true`, the SDK will log spans to the console instead of sending the
83
83
  exporter. This should just be used for debugging purposes.
84
84
  ### config
85
85
 
86
- <MemberInfo kind="property" type={`Partial&#60;NodeSDKConfiguration&#62;`} />
86
+ <MemberInfo kind="property" type={`Partial<NodeSDKConfiguration>`} />
87
87
 
88
88
  The configuration object for the OpenTelemetry Node SDK.
89
89
 
@@ -37,9 +37,9 @@ Parameters
37
37
 
38
38
  ### target
39
39
 
40
- <MemberInfo kind="parameter" type={`Type&#60;T&#62;`} />
40
+ <MemberInfo kind="parameter" type={`Type<T>`} />
41
41
 
42
42
  ### hooks
43
43
 
44
- <MemberInfo kind="parameter" type={`MethodHooksForType&#60;T&#62;`} />
44
+ <MemberInfo kind="parameter" type={`MethodHooksForType<T>`} />
45
45
 
@@ -38,7 +38,7 @@ TelemetryPlugin.init({
38
38
  ```
39
39
  ### methodHooks
40
40
 
41
- <MemberInfo kind="property" type={`Array&#60;MethodHookConfig&#60;any&#62;&#62;`} experimental="true" />
41
+ <MemberInfo kind="property" type={`Array<MethodHookConfig<any>>`} experimental="true" />
42
42
 
43
43
  **Status: Developer Preview**
44
44
 
@@ -60,7 +60,7 @@ interface AssetGalleryProps {
60
60
 
61
61
  ### onSelect
62
62
 
63
- <MemberInfo kind="property" type={`(assets: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[]) =&#62; void`} />
63
+ <MemberInfo kind="property" type={`(assets: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[]) => void`} />
64
64
 
65
65
 
66
66
  ### selectable
@@ -103,7 +103,7 @@ Whether the gallery should show a header.
103
103
  The class name to apply to the gallery.
104
104
  ### onFilesDropped
105
105
 
106
- <MemberInfo kind="property" type={`(files: File[]) =&#62; void`} />
106
+ <MemberInfo kind="property" type={`(files: File[]) => void`} />
107
107
 
108
108
  The function to call when files are dropped.
109
109
  ### bulkActions
@@ -118,7 +118,7 @@ The bulk actions to display in the gallery.
118
118
  Whether the gallery should display bulk actions.
119
119
  ### onPageSizeChange
120
120
 
121
- <MemberInfo kind="property" type={`(pageSize: number) =&#62; void`} />
121
+ <MemberInfo kind="property" type={`(pageSize: number) => void`} />
122
122
 
123
123
  The function to call when the page size changes.
124
124
 
@@ -47,12 +47,12 @@ interface AssetPickerDialogProps {
47
47
  Whether the dialog is open.
48
48
  ### onClose
49
49
 
50
- <MemberInfo kind="property" type={`() =&#62; void`} />
50
+ <MemberInfo kind="property" type={`() => void`} />
51
51
 
52
52
  The function to call when the dialog is closed.
53
53
  ### onSelect
54
54
 
55
- <MemberInfo kind="property" type={`(assets: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[]) =&#62; void`} />
55
+ <MemberInfo kind="property" type={`(assets: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[]) => void`} />
56
56
 
57
57
  The function to call when assets are selected.
58
58
  ### multiSelect