@vendure/docs 0.0.0-202601280949 → 0.0.0-202601281114

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 (386) hide show
  1. package/dist/dates.generated.js +385 -385
  2. package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +2 -2
  3. package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +1 -1
  4. package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +1 -1
  5. package/docs/reference/admin-ui-api/action-bar/action-bar-location-id.mdx +1 -1
  6. package/docs/reference/admin-ui-api/action-bar/router-link-definition.mdx +1 -1
  7. package/docs/reference/admin-ui-api/alerts/alert-context.mdx +1 -1
  8. package/docs/reference/admin-ui-api/alerts/register-alert.mdx +1 -1
  9. package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +2 -2
  10. package/docs/reference/admin-ui-api/bulk-actions/register-bulk-action.mdx +1 -1
  11. package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +1 -1
  12. package/docs/reference/admin-ui-api/components/data-table-component.mdx +2 -2
  13. package/docs/reference/admin-ui-api/components/data-table2component.mdx +1 -1
  14. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +1 -1
  15. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-location-id.mdx +1 -1
  16. package/docs/reference/admin-ui-api/custom-detail-components/register-custom-detail-component.mdx +1 -1
  17. package/docs/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component.mdx +2 -2
  18. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +1 -1
  19. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -1
  20. package/docs/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component.mdx +2 -2
  21. package/docs/reference/admin-ui-api/custom-history-entry-components/register-history-entry-component.mdx +1 -1
  22. package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +19 -19
  23. package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +2 -2
  24. package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +2 -2
  25. package/docs/reference/admin-ui-api/custom-table-components/register-data-table-component.mdx +1 -1
  26. package/docs/reference/admin-ui-api/dashboard-widgets/register-dashboard-widget.mdx +1 -1
  27. package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +1 -1
  28. package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +1 -1
  29. package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +1 -1
  30. package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +1 -1
  31. package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -1
  32. package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +2 -2
  33. package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +2 -2
  34. package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -1
  35. package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +1 -1
  36. package/docs/reference/admin-ui-api/react-extensions/register-react-custom-detail-component.mdx +1 -1
  37. package/docs/reference/admin-ui-api/react-extensions/register-react-form-input-component.mdx +1 -1
  38. package/docs/reference/admin-ui-api/services/data-service.mdx +1 -1
  39. package/docs/reference/admin-ui-api/services/modal-service.mdx +1 -1
  40. package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +6 -8
  41. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-build-command.mdx +1 -1
  42. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-options.mdx +2 -2
  43. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-process-argument.mdx +1 -1
  44. package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
  45. package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +5 -5
  46. package/docs/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy.mdx +2 -2
  47. package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
  48. package/docs/reference/core-plugins/asset-server-plugin/index.mdx +3 -3
  49. package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +1 -1
  50. package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +3 -3
  51. package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +5 -5
  52. package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +3 -3
  53. package/docs/reference/core-plugins/dashboard-plugin/dashboard-plugin-options.mdx +1 -1
  54. package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +1 -1
  55. package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
  56. package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +2 -2
  57. package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +10 -10
  58. package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
  59. package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
  60. package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +2 -2
  61. package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +9 -9
  62. package/docs/reference/core-plugins/email-plugin/email-send-event.mdx +1 -1
  63. package/docs/reference/core-plugins/email-plugin/email-sender.mdx +3 -3
  64. package/docs/reference/core-plugins/email-plugin/index.mdx +4 -4
  65. package/docs/reference/core-plugins/email-plugin/template-loader.mdx +1 -1
  66. package/docs/reference/core-plugins/email-plugin/transport-options.mdx +2 -2
  67. package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -1
  68. package/docs/reference/core-plugins/harden-plugin/index.mdx +2 -2
  69. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +1 -1
  70. package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +1 -1
  71. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +1 -1
  72. package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +1 -1
  73. package/docs/reference/core-plugins/sentry-plugin/sentry-plugin-options.mdx +1 -1
  74. package/docs/reference/core-plugins/stellate-plugin/index.mdx +3 -3
  75. package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +3 -3
  76. package/docs/reference/core-plugins/stellate-plugin/stellate-plugin-options.mdx +1 -1
  77. package/docs/reference/core-plugins/telemetry-plugin/otel-logger.mdx +1 -1
  78. package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +1 -1
  79. package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -1
  80. package/docs/reference/dashboard/components/asset-gallery.mdx +1 -1
  81. package/docs/reference/dashboard/components/asset-picker-dialog.mdx +1 -1
  82. package/docs/reference/dashboard/components/vendure-image.mdx +5 -5
  83. package/docs/reference/dashboard/detail-views/detail-page.mdx +2 -2
  84. package/docs/reference/dashboard/detail-views/use-generated-form.mdx +1 -1
  85. package/docs/reference/dashboard/extensions-api/form-components.mdx +1 -1
  86. package/docs/reference/dashboard/extensions-api/history-entries.mdx +3 -3
  87. package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
  88. package/docs/reference/dashboard/form-components/translatable-form-field-wrapper.mdx +1 -1
  89. package/docs/reference/dashboard/hooks/use-auth.mdx +1 -1
  90. package/docs/reference/dashboard/hooks/use-channel.mdx +1 -1
  91. package/docs/reference/dashboard/list-views/data-table.mdx +1 -1
  92. package/docs/reference/dashboard/list-views/list-page.mdx +2 -2
  93. package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +2 -2
  94. package/docs/reference/dashboard/page-layout/index.mdx +2 -2
  95. package/docs/reference/dashboard/page-layout/page-action-bar.mdx +2 -2
  96. package/docs/reference/dashboard/page-layout/page-block.mdx +4 -4
  97. package/docs/reference/dashboard/page-layout/page-title.mdx +1 -1
  98. package/docs/reference/dashboard/page-layout/page.mdx +4 -4
  99. package/docs/reference/dashboard/vite-plugin/vendure-dashboard-plugin.mdx +4 -4
  100. package/docs/reference/typescript-api/assets/asset-naming-strategy.mdx +1 -1
  101. package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
  102. package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +1 -1
  103. package/docs/reference/typescript-api/assets/default-asset-naming-strategy.mdx +1 -1
  104. package/docs/reference/typescript-api/auth/auth-options.mdx +4 -4
  105. package/docs/reference/typescript-api/auth/authentication-strategy.mdx +2 -2
  106. package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +1 -1
  107. package/docs/reference/typescript-api/auth/default-password-validation-strategy.mdx +1 -1
  108. package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +4 -4
  109. package/docs/reference/typescript-api/auth/default-verification-token-strategy.mdx +1 -1
  110. package/docs/reference/typescript-api/auth/external-authentication-service.mdx +1 -1
  111. package/docs/reference/typescript-api/auth/in-memory-session-cache-strategy.mdx +1 -1
  112. package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +1 -1
  113. package/docs/reference/typescript-api/auth/noop-session-cache-strategy.mdx +1 -1
  114. package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +2 -2
  115. package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +2 -2
  116. package/docs/reference/typescript-api/auth/permission-definition.mdx +12 -12
  117. package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +5 -5
  118. package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +1 -1
  119. package/docs/reference/typescript-api/cache/cache-config.mdx +1 -1
  120. package/docs/reference/typescript-api/cache/cache-service.mdx +2 -2
  121. package/docs/reference/typescript-api/cache/cache-strategy.mdx +2 -2
  122. package/docs/reference/typescript-api/cache/default-cache-plugin.mdx +3 -3
  123. package/docs/reference/typescript-api/cache/index.mdx +2 -2
  124. package/docs/reference/typescript-api/cache/redis-cache-plugin.mdx +3 -3
  125. package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +2 -2
  126. package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +2 -2
  127. package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +3 -3
  128. package/docs/reference/typescript-api/common/admin-ui/admin-ui-config.mdx +1 -1
  129. package/docs/reference/typescript-api/common/id.mdx +1 -1
  130. package/docs/reference/typescript-api/common/injectable-strategy.mdx +1 -1
  131. package/docs/reference/typescript-api/common/middleware.mdx +1 -1
  132. package/docs/reference/typescript-api/common/permission.mdx +1 -1
  133. package/docs/reference/typescript-api/common/price-calculation-result.mdx +2 -2
  134. package/docs/reference/typescript-api/configurable-operation-def/config-arg-type.mdx +1 -1
  135. package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +3 -3
  136. package/docs/reference/typescript-api/configurable-operation-def/configurable-operation-def-options.mdx +3 -3
  137. package/docs/reference/typescript-api/configurable-operation-def/index.mdx +10 -10
  138. package/docs/reference/typescript-api/configurable-operation-def/localized-string-array.mdx +1 -1
  139. package/docs/reference/typescript-api/configuration/api-options.mdx +1 -1
  140. package/docs/reference/typescript-api/configuration/collection-filter.mdx +1 -1
  141. package/docs/reference/typescript-api/configuration/default-slug-strategy.mdx +1 -1
  142. package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +2 -2
  143. package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +5 -5
  144. package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
  145. package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +2 -2
  146. package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +4 -4
  147. package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +2 -2
  148. package/docs/reference/typescript-api/configuration/settings-store-fields.mdx +1 -1
  149. package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
  150. package/docs/reference/typescript-api/configuration/system-options.mdx +3 -3
  151. package/docs/reference/typescript-api/configuration/vendure-config.mdx +2 -2
  152. package/docs/reference/typescript-api/custom-fields/index.mdx +1 -1
  153. package/docs/reference/typescript-api/custom-fields/typed-custom-single-field-config.mdx +1 -1
  154. package/docs/reference/typescript-api/data-access/calculated.mdx +2 -2
  155. package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
  156. package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +2 -2
  157. package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
  158. package/docs/reference/typescript-api/data-access/list-query-builder.mdx +1 -1
  159. package/docs/reference/typescript-api/data-access/transactional-connection.mdx +7 -7
  160. package/docs/reference/typescript-api/default-search-plugin/default-search-plugin-init-options.mdx +2 -2
  161. package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +1 -1
  162. package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +1 -1
  163. package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +2 -2
  164. package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +1 -1
  165. package/docs/reference/typescript-api/entities/address.mdx +2 -2
  166. package/docs/reference/typescript-api/entities/administrator.mdx +3 -3
  167. package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
  168. package/docs/reference/typescript-api/entities/asset.mdx +2 -2
  169. package/docs/reference/typescript-api/entities/authenticated-session.mdx +3 -3
  170. package/docs/reference/typescript-api/entities/authentication-method.mdx +5 -5
  171. package/docs/reference/typescript-api/entities/channel.mdx +1 -1
  172. package/docs/reference/typescript-api/entities/collection.mdx +3 -3
  173. package/docs/reference/typescript-api/entities/country.mdx +4 -4
  174. package/docs/reference/typescript-api/entities/customer-group.mdx +2 -2
  175. package/docs/reference/typescript-api/entities/customer-history-entry.mdx +2 -2
  176. package/docs/reference/typescript-api/entities/customer.mdx +3 -3
  177. package/docs/reference/typescript-api/entities/facet-value.mdx +3 -3
  178. package/docs/reference/typescript-api/entities/facet.mdx +4 -4
  179. package/docs/reference/typescript-api/entities/fulfillment.mdx +2 -2
  180. package/docs/reference/typescript-api/entities/global-settings.mdx +1 -1
  181. package/docs/reference/typescript-api/entities/history-entry.mdx +3 -3
  182. package/docs/reference/typescript-api/entities/order-history-entry.mdx +2 -2
  183. package/docs/reference/typescript-api/entities/order-line-reference.mdx +8 -8
  184. package/docs/reference/typescript-api/entities/order-line.mdx +8 -8
  185. package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
  186. package/docs/reference/typescript-api/entities/order.mdx +9 -9
  187. package/docs/reference/typescript-api/entities/orderable-asset.mdx +2 -2
  188. package/docs/reference/typescript-api/entities/payment-method.mdx +4 -4
  189. package/docs/reference/typescript-api/entities/payment.mdx +2 -2
  190. package/docs/reference/typescript-api/entities/product-option-group.mdx +3 -3
  191. package/docs/reference/typescript-api/entities/product-option.mdx +3 -3
  192. package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -1
  193. package/docs/reference/typescript-api/entities/product-variant.mdx +3 -3
  194. package/docs/reference/typescript-api/entities/product.mdx +3 -3
  195. package/docs/reference/typescript-api/entities/promotion.mdx +3 -3
  196. package/docs/reference/typescript-api/entities/province.mdx +2 -2
  197. package/docs/reference/typescript-api/entities/refund.mdx +1 -1
  198. package/docs/reference/typescript-api/entities/region.mdx +4 -4
  199. package/docs/reference/typescript-api/entities/role.mdx +3 -3
  200. package/docs/reference/typescript-api/entities/seller.mdx +3 -3
  201. package/docs/reference/typescript-api/entities/session.mdx +3 -3
  202. package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
  203. package/docs/reference/typescript-api/entities/shipping-line.mdx +2 -2
  204. package/docs/reference/typescript-api/entities/shipping-method.mdx +4 -4
  205. package/docs/reference/typescript-api/entities/stock-level.mdx +3 -3
  206. package/docs/reference/typescript-api/entities/stock-location.mdx +4 -4
  207. package/docs/reference/typescript-api/entities/stock-movement.mdx +7 -7
  208. package/docs/reference/typescript-api/entities/surcharge.mdx +2 -2
  209. package/docs/reference/typescript-api/entities/tag.mdx +1 -1
  210. package/docs/reference/typescript-api/entities/tax-category.mdx +2 -2
  211. package/docs/reference/typescript-api/entities/tax-rate.mdx +5 -5
  212. package/docs/reference/typescript-api/entities/user.mdx +3 -3
  213. package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -1
  214. package/docs/reference/typescript-api/entities/zone.mdx +2 -2
  215. package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +1 -1
  216. package/docs/reference/typescript-api/errors/error-types.mdx +8 -8
  217. package/docs/reference/typescript-api/errors/is-graph-ql-error-result.mdx +1 -1
  218. package/docs/reference/typescript-api/events/event-bus.mdx +6 -6
  219. package/docs/reference/typescript-api/events/event-types.mdx +109 -109
  220. package/docs/reference/typescript-api/events/vendure-entity-event.mdx +1 -1
  221. package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +5 -5
  222. package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +5 -5
  223. package/docs/reference/typescript-api/fulfillment/fulfillment-state.mdx +1 -1
  224. package/docs/reference/typescript-api/fulfillment/fulfillment-states.mdx +1 -1
  225. package/docs/reference/typescript-api/health-check/health-check-registry-service.mdx +3 -3
  226. package/docs/reference/typescript-api/health-check/health-check-strategy.mdx +2 -2
  227. package/docs/reference/typescript-api/health-check/http-health-check-strategy.mdx +2 -2
  228. package/docs/reference/typescript-api/health-check/type-ormhealth-check-strategy.mdx +2 -2
  229. package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +3 -3
  230. package/docs/reference/typescript-api/import-export/asset-importer.mdx +2 -2
  231. package/docs/reference/typescript-api/import-export/default-asset-import-strategy.mdx +1 -1
  232. package/docs/reference/typescript-api/import-export/import-export-options.mdx +1 -1
  233. package/docs/reference/typescript-api/import-export/import-parser.mdx +8 -8
  234. package/docs/reference/typescript-api/import-export/importer.mdx +2 -2
  235. package/docs/reference/typescript-api/import-export/populate.mdx +3 -3
  236. package/docs/reference/typescript-api/import-export/populator.mdx +2 -2
  237. package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -5
  238. package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +4 -4
  239. package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +4 -4
  240. package/docs/reference/typescript-api/job-queue/index.mdx +4 -4
  241. package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +1 -1
  242. package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +2 -2
  243. package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
  244. package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +4 -4
  245. package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +2 -2
  246. package/docs/reference/typescript-api/job-queue/job.mdx +2 -2
  247. package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +3 -3
  248. package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +4 -4
  249. package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +5 -5
  250. package/docs/reference/typescript-api/job-queue/types.mdx +5 -5
  251. package/docs/reference/typescript-api/logger/default-logger.mdx +1 -1
  252. package/docs/reference/typescript-api/logger/index.mdx +3 -3
  253. package/docs/reference/typescript-api/migration/migration-options.mdx +1 -1
  254. package/docs/reference/typescript-api/money/big-int-money-strategy.mdx +3 -3
  255. package/docs/reference/typescript-api/money/default-money-strategy.mdx +2 -2
  256. package/docs/reference/typescript-api/money/money-decorator.mdx +1 -1
  257. package/docs/reference/typescript-api/money/money-strategy.mdx +5 -5
  258. package/docs/reference/typescript-api/money/round-money.mdx +1 -1
  259. package/docs/reference/typescript-api/orders/active-order-service.mdx +1 -1
  260. package/docs/reference/typescript-api/orders/active-order-strategy.mdx +2 -2
  261. package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +2 -2
  262. package/docs/reference/typescript-api/orders/custom-order-states.mdx +1 -1
  263. package/docs/reference/typescript-api/orders/default-active-order-strategy.mdx +2 -2
  264. package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +3 -3
  265. package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +2 -2
  266. package/docs/reference/typescript-api/orders/default-order-placed-strategy.mdx +2 -2
  267. package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -1
  268. package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
  269. package/docs/reference/typescript-api/orders/merge-strategies.mdx +4 -4
  270. package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +2 -2
  271. package/docs/reference/typescript-api/orders/order-code-strategy.mdx +2 -2
  272. package/docs/reference/typescript-api/orders/order-interceptor.mdx +5 -5
  273. package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +3 -3
  274. package/docs/reference/typescript-api/orders/order-merge-strategy.mdx +2 -2
  275. package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
  276. package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
  277. package/docs/reference/typescript-api/orders/order-process.mdx +13 -13
  278. package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +5 -5
  279. package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
  280. package/docs/reference/typescript-api/payment/default-payment-process.mdx +1 -1
  281. package/docs/reference/typescript-api/payment/default-refund-process.mdx +1 -1
  282. package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +4 -4
  283. package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +5 -5
  284. package/docs/reference/typescript-api/payment/payment-method-handler.mdx +2 -2
  285. package/docs/reference/typescript-api/payment/payment-method-types.mdx +16 -16
  286. package/docs/reference/typescript-api/payment/payment-options.mdx +7 -7
  287. package/docs/reference/typescript-api/payment/payment-process.mdx +2 -2
  288. package/docs/reference/typescript-api/payment/payment-states.mdx +1 -1
  289. package/docs/reference/typescript-api/payment/refund-process.mdx +2 -2
  290. package/docs/reference/typescript-api/payment/refund-states.mdx +1 -1
  291. package/docs/reference/typescript-api/plugin/plugin-common-module.mdx +3 -3
  292. package/docs/reference/typescript-api/plugin/plugin-utilities.mdx +1 -1
  293. package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +3 -3
  294. package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
  295. package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
  296. package/docs/reference/typescript-api/products-stock/default-stock-display-strategy.mdx +1 -1
  297. package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +2 -2
  298. package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -2
  299. package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +2 -2
  300. package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
  301. package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +5 -5
  302. package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +3 -3
  303. package/docs/reference/typescript-api/promotions/promotion-action.mdx +20 -20
  304. package/docs/reference/typescript-api/promotions/promotion-condition.mdx +6 -6
  305. package/docs/reference/typescript-api/request/allow-decorator.mdx +1 -1
  306. package/docs/reference/typescript-api/request/api-decorator.mdx +1 -1
  307. package/docs/reference/typescript-api/request/ctx-decorator.mdx +1 -1
  308. package/docs/reference/typescript-api/request/relations-decorator.mdx +1 -1
  309. package/docs/reference/typescript-api/request/request-context-service.mdx +1 -1
  310. package/docs/reference/typescript-api/request/request-context.mdx +5 -5
  311. package/docs/reference/typescript-api/request/transaction-decorator.mdx +2 -2
  312. package/docs/reference/typescript-api/scheduled-tasks/clean-sessions-task.mdx +1 -1
  313. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-plugin.mdx +1 -1
  314. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +3 -3
  315. package/docs/reference/typescript-api/scheduled-tasks/scheduler-options.mdx +2 -2
  316. package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +4 -4
  317. package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +3 -3
  318. package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +1 -1
  319. package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -1
  320. package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +1 -1
  321. package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +1 -1
  322. package/docs/reference/typescript-api/services/administrator-service.mdx +1 -1
  323. package/docs/reference/typescript-api/services/asset-service.mdx +3 -3
  324. package/docs/reference/typescript-api/services/auth-service.mdx +3 -3
  325. package/docs/reference/typescript-api/services/channel-service.mdx +3 -3
  326. package/docs/reference/typescript-api/services/collection-service.mdx +3 -3
  327. package/docs/reference/typescript-api/services/country-service.mdx +1 -1
  328. package/docs/reference/typescript-api/services/customer-group-service.mdx +2 -2
  329. package/docs/reference/typescript-api/services/customer-service.mdx +13 -13
  330. package/docs/reference/typescript-api/services/facet-service.mdx +1 -1
  331. package/docs/reference/typescript-api/services/facet-value-service.mdx +1 -1
  332. package/docs/reference/typescript-api/services/fulfillment-service.mdx +3 -3
  333. package/docs/reference/typescript-api/services/global-settings-service.mdx +1 -1
  334. package/docs/reference/typescript-api/services/history-service.mdx +1 -1
  335. package/docs/reference/typescript-api/services/order-service.mdx +24 -24
  336. package/docs/reference/typescript-api/services/payment-method-service.mdx +1 -1
  337. package/docs/reference/typescript-api/services/payment-service.mdx +6 -6
  338. package/docs/reference/typescript-api/services/product-option-group-service.mdx +1 -1
  339. package/docs/reference/typescript-api/services/product-option-service.mdx +1 -1
  340. package/docs/reference/typescript-api/services/product-service.mdx +2 -2
  341. package/docs/reference/typescript-api/services/product-variant-service.mdx +7 -7
  342. package/docs/reference/typescript-api/services/promotion-service.mdx +1 -1
  343. package/docs/reference/typescript-api/services/province-service.mdx +1 -1
  344. package/docs/reference/typescript-api/services/role-service.mdx +1 -1
  345. package/docs/reference/typescript-api/services/seller-service.mdx +1 -1
  346. package/docs/reference/typescript-api/services/session-service.mdx +4 -4
  347. package/docs/reference/typescript-api/services/shipping-method-service.mdx +1 -1
  348. package/docs/reference/typescript-api/services/stock-level-service.mdx +5 -5
  349. package/docs/reference/typescript-api/services/stock-location-service.mdx +5 -5
  350. package/docs/reference/typescript-api/services/stock-movement-service.mdx +8 -8
  351. package/docs/reference/typescript-api/services/tag-service.mdx +1 -1
  352. package/docs/reference/typescript-api/services/tax-category-service.mdx +1 -1
  353. package/docs/reference/typescript-api/services/tax-rate-service.mdx +1 -1
  354. package/docs/reference/typescript-api/services/user-service.mdx +8 -8
  355. package/docs/reference/typescript-api/services/zone-service.mdx +1 -1
  356. package/docs/reference/typescript-api/settings-store/index.mdx +1 -1
  357. package/docs/reference/typescript-api/shipping/check-shipping-eligibility-checker-fn.mdx +2 -2
  358. package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +2 -2
  359. package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +5 -5
  360. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +2 -2
  361. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +2 -2
  362. package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +3 -3
  363. package/docs/reference/typescript-api/shipping/shipping-options.mdx +3 -3
  364. package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +1 -1
  365. package/docs/reference/typescript-api/state-machine/transitions.mdx +2 -2
  366. package/docs/reference/typescript-api/tax/address-based-tax-zone-strategy.mdx +3 -3
  367. package/docs/reference/typescript-api/tax/default-tax-line-calculation-strategy.mdx +3 -3
  368. package/docs/reference/typescript-api/tax/default-tax-zone-strategy.mdx +2 -2
  369. package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +3 -3
  370. package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +2 -2
  371. package/docs/reference/typescript-api/telemetry/instrument.mdx +1 -1
  372. package/docs/reference/typescript-api/telemetry/instrumentation-strategy.mdx +2 -2
  373. package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +1 -1
  374. package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -1
  375. package/docs/reference/typescript-api/testing/create-test-environment.mdx +2 -2
  376. package/docs/reference/typescript-api/testing/get-superadmin-context.mdx +1 -1
  377. package/docs/reference/typescript-api/testing/register-initializer.mdx +2 -2
  378. package/docs/reference/typescript-api/testing/test-config.mdx +1 -1
  379. package/docs/reference/typescript-api/testing/test-db-initializer.mdx +1 -1
  380. package/docs/reference/typescript-api/testing/test-environment.mdx +1 -1
  381. package/docs/reference/typescript-api/testing/test-server-options.mdx +1 -1
  382. package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
  383. package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -2
  384. package/docs/reference/typescript-api/worker/vendure-worker.mdx +1 -1
  385. package/package.json +1 -1
  386. package/src/dates.generated.ts +385 -385
@@ -16,7 +16,7 @@ class VendureEntityEvent<Entity, Input = any> extends VendureEvent {
16
16
  constructor(entity: Entity, type: 'created' | 'updated' | 'deleted', ctx: RequestContext, input?: Input)
17
17
  }
18
18
  ```
19
- * Extends: <DocsLink href="/reference/typescript-api/events/vendure-event#vendureevent">`VendureEvent`</DocsLink>
19
+ * Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
20
20
 
21
21
 
22
22
 
@@ -4,7 +4,7 @@ generated: true
4
4
  ---
5
5
  <GenerationInfo sourceFile="packages/core/src/config/fulfillment/fulfillment-handler.ts" sourceLine="149" packageName="@vendure/core" />
6
6
 
7
- A FulfillmentHandler is used when creating a new <DocsLink href="/reference/typescript-api/entities/fulfillment#fulfillment">Fulfillment</DocsLink>. When the `addFulfillmentToOrder` mutation
7
+ A FulfillmentHandler is used when creating a new [Fulfillment](/reference/typescript-api/entities/fulfillment#fulfillment). When the `addFulfillmentToOrder` mutation
8
8
  is executed, the specified handler will be used and it's `createFulfillment` method is called. This method
9
9
  may perform async tasks such as calling a 3rd-party shipping API to register a new shipment and receive
10
10
  a tracking code. This data can then be returned and will be incorporated into the created Fulfillment.
@@ -83,7 +83,7 @@ class FulfillmentHandler<T extends ConfigArgs = ConfigArgs> extends Configurable
83
83
  constructor(config: FulfillmentHandlerConfig<T>)
84
84
  }
85
85
  ```
86
- * Extends: <DocsLink href="/reference/typescript-api/configurable-operation-def/#configurableoperationdef">`ConfigurableOperationDef`</DocsLink>`<T>`
86
+ * Extends: [`ConfigurableOperationDef`](/reference/typescript-api/configurable-operation-def/#configurableoperationdef)`<T>`
87
87
 
88
88
 
89
89
 
@@ -99,7 +99,7 @@ class FulfillmentHandler<T extends ConfigArgs = ConfigArgs> extends Configurable
99
99
  </div>
100
100
  <GenerationInfo sourceFile="packages/core/src/config/fulfillment/fulfillment-handler.ts" sourceLine="48" packageName="@vendure/core" />
101
101
 
102
- The configuration object used to instantiate a <DocsLink href="/reference/typescript-api/fulfillment/fulfillment-handler#fulfillmenthandler">FulfillmentHandler</DocsLink>.
102
+ The configuration object used to instantiate a [FulfillmentHandler](/reference/typescript-api/fulfillment/fulfillment-handler#fulfillmenthandler).
103
103
 
104
104
  ```ts title="Signature"
105
105
  interface FulfillmentHandlerConfig<T extends ConfigArgs> extends ConfigurableOperationDefOptions<T> {
@@ -107,7 +107,7 @@ interface FulfillmentHandlerConfig<T extends ConfigArgs> extends ConfigurableOpe
107
107
  onFulfillmentTransition?: OnTransitionStartFn<FulfillmentState, FulfillmentTransitionData>;
108
108
  }
109
109
  ```
110
- * Extends: <DocsLink href="/reference/typescript-api/configurable-operation-def/configurable-operation-def-options#configurableoperationdefoptions">`ConfigurableOperationDefOptions`</DocsLink>`<T>`
110
+ * Extends: [`ConfigurableOperationDefOptions`](/reference/typescript-api/configurable-operation-def/configurable-operation-def-options#configurableoperationdefoptions)`<T>`
111
111
 
112
112
 
113
113
 
@@ -126,7 +126,7 @@ result will be returned.
126
126
  <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a><<a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a>, <a href='/reference/typescript-api/fulfillment/fulfillment-transition-data#fulfillmenttransitiondata'>FulfillmentTransitionData</a>>`} />
127
127
 
128
128
  This allows the handler to intercept state transitions of the created Fulfillment. This works much in the
129
- same way as the <DocsLink href="/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess">FulfillmentProcess</DocsLink> `onTransitionStart` method (i.e. returning `false` or
129
+ same way as the [FulfillmentProcess](/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess) `onTransitionStart` method (i.e. returning `false` or
130
130
  `string` will be interpreted as an error and prevent the state transition), except that it is only invoked
131
131
  on Fulfillments which were created with this particular FulfillmentHandler.
132
132
 
@@ -4,14 +4,14 @@ generated: true
4
4
  ---
5
5
  <GenerationInfo sourceFile="packages/core/src/config/fulfillment/default-fulfillment-process.ts" sourceLine="45" packageName="@vendure/core" since="2.0.0" />
6
6
 
7
- The default <DocsLink href="/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess">FulfillmentProcess</DocsLink>. This process includes the following actions:
7
+ The default [FulfillmentProcess](/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess). This process includes the following actions:
8
8
 
9
9
  - Executes the configured `FulfillmentHandler.onFulfillmentTransition()` before any state
10
10
  transition.
11
- - On cancellation of a Fulfillment, creates the necessary <DocsLink href="/reference/typescript-api/entities/stock-movement#cancellation">Cancellation</DocsLink> & <DocsLink href="/reference/typescript-api/entities/stock-movement#allocation">Allocation</DocsLink>
11
+ - On cancellation of a Fulfillment, creates the necessary [Cancellation](/reference/typescript-api/entities/stock-movement#cancellation) & [Allocation](/reference/typescript-api/entities/stock-movement#allocation)
12
12
  stock movement records.
13
13
  - When a Fulfillment transitions from the `Created` to `Pending` state, the necessary
14
- <DocsLink href="/reference/typescript-api/entities/stock-movement#sale">Sale</DocsLink> stock movements are created.
14
+ [Sale](/reference/typescript-api/entities/stock-movement#sale) stock movements are created.
15
15
 
16
16
  <GenerationInfo sourceFile="packages/core/src/config/fulfillment/fulfillment-process.ts" sourceLine="26" packageName="@vendure/core" since="2.0.0" />
17
17
 
@@ -20,7 +20,7 @@ in, and how it may transition from one state to another. Using the `onTransition
20
20
  FulfillmentProcess can perform checks before allowing a state transition to occur, and the `onTransitionEnd()`
21
21
  hook allows logic to be executed after a state change.
22
22
 
23
- For detailed description of the interface members, see the <DocsLink href="/reference/typescript-api/state-machine/state-machine-config#statemachineconfig">StateMachineConfig</DocsLink> docs.
23
+ For detailed description of the interface members, see the [StateMachineConfig](/reference/typescript-api/state-machine/state-machine-config#statemachineconfig) docs.
24
24
 
25
25
  ```ts title="Signature"
26
26
  interface FulfillmentProcess<State extends keyof CustomFulfillmentStates | string> extends InjectableStrategy {
@@ -31,7 +31,7 @@ interface FulfillmentProcess<State extends keyof CustomFulfillmentStates | strin
31
31
  onTransitionError?: OnTransitionErrorFn<State | FulfillmentState>;
32
32
  }
33
33
  ```
34
- * Extends: <DocsLink href="/reference/typescript-api/common/injectable-strategy#injectablestrategy">`InjectableStrategy`</DocsLink>
34
+ * Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
35
35
 
36
36
 
37
37
 
@@ -5,7 +5,7 @@ generated: true
5
5
  <GenerationInfo sourceFile="packages/core/src/service/helpers/fulfillment-state-machine/fulfillment-state.ts" sourceLine="29" packageName="@vendure/core" />
6
6
 
7
7
  These are the default states of the fulfillment process. By default, they will be extended
8
- by the <DocsLink href="/reference/typescript-api/fulfillment/fulfillment-process#defaultfulfillmentprocess">defaultFulfillmentProcess</DocsLink> to also include `Shipped` and `Delivered`.
8
+ by the [defaultFulfillmentProcess](/reference/typescript-api/fulfillment/fulfillment-process#defaultfulfillmentprocess) to also include `Shipped` and `Delivered`.
9
9
 
10
10
  ```ts title="Signature"
11
11
  type FulfillmentState = | 'Created'
@@ -4,7 +4,7 @@ generated: true
4
4
  ---
5
5
  <GenerationInfo sourceFile="packages/core/src/service/helpers/fulfillment-state-machine/fulfillment-state.ts" sourceLine="19" packageName="@vendure/core" />
6
6
 
7
- An interface to extend standard <DocsLink href="/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate">FulfillmentState</DocsLink>.
7
+ An interface to extend standard [FulfillmentState](/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate).
8
8
 
9
9
  ```ts title="Signature"
10
10
  interface FulfillmentStates {
@@ -17,12 +17,12 @@ Plugins which rely on external services (web services, databases etc.) can make
17
17
  service to add a check for that dependency to the Vendure health check.
18
18
 
19
19
 
20
- Since v1.6.0, the preferred way to implement a custom health check is by creating a new <DocsLink href="/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy">HealthCheckStrategy</DocsLink>
20
+ Since v1.6.0, the preferred way to implement a custom health check is by creating a new [HealthCheckStrategy](/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy)
21
21
  and then passing it to the `systemOptions.healthChecks` array.
22
- See the <DocsLink href="/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy">HealthCheckStrategy</DocsLink> docs for an example configuration.
22
+ See the [HealthCheckStrategy](/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy) docs for an example configuration.
23
23
 
24
24
  The alternative way to register a health check is by injecting this service directly into your
25
- plugin module. To use it in your plugin, you'll need to import the <DocsLink href="/reference/typescript-api/plugin/plugin-common-module#plugincommonmodule">PluginCommonModule</DocsLink>:
25
+ plugin module. To use it in your plugin, you'll need to import the [PluginCommonModule](/reference/typescript-api/plugin/plugin-common-module#plugincommonmodule):
26
26
 
27
27
  *Example*
28
28
 
@@ -15,7 +15,7 @@ Custom strategies should be added to the `systemOptions.healthChecks` array.
15
15
  By default, Vendure includes the `TypeORMHealthCheckStrategy`, so if you set the value of the `healthChecks`
16
16
  array, be sure to include it manually.
17
17
 
18
- Vendure also ships with the <DocsLink href="/reference/typescript-api/health-check/http-health-check-strategy#httphealthcheckstrategy">HttpHealthCheckStrategy</DocsLink>, which is convenient
18
+ Vendure also ships with the [HttpHealthCheckStrategy](/reference/typescript-api/health-check/http-health-check-strategy#httphealthcheckstrategy), which is convenient
19
19
  for adding a health check dependent on an HTTP ping.
20
20
 
21
21
  :::info
@@ -48,7 +48,7 @@ interface HealthCheckStrategy extends InjectableStrategy {
48
48
  getHealthIndicator(): HealthIndicatorFunction;
49
49
  }
50
50
  ```
51
- * Extends: <DocsLink href="/reference/typescript-api/common/injectable-strategy#injectablestrategy">`InjectableStrategy`</DocsLink>
51
+ * Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
52
52
 
53
53
 
54
54
 
@@ -4,7 +4,7 @@ generated: true
4
4
  ---
5
5
  <GenerationInfo sourceFile="packages/core/src/health-check/http-health-check-strategy.ts" sourceLine="37" packageName="@vendure/core" />
6
6
 
7
- A <DocsLink href="/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy">HealthCheckStrategy</DocsLink> used to check health by pinging a url. Internally it uses
7
+ A [HealthCheckStrategy](/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy) used to check health by pinging a url. Internally it uses
8
8
  the [NestJS HttpHealthIndicator](https://docs.nestjs.com/recipes/terminus#http-healthcheck).
9
9
 
10
10
  *Example*
@@ -30,7 +30,7 @@ class HttpHealthCheckStrategy implements HealthCheckStrategy {
30
30
  getHealthIndicator() => HealthIndicatorFunction;
31
31
  }
32
32
  ```
33
- * Implements: <DocsLink href="/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy">`HealthCheckStrategy`</DocsLink>
33
+ * Implements: [`HealthCheckStrategy`](/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy)
34
34
 
35
35
 
36
36
 
@@ -4,7 +4,7 @@ generated: true
4
4
  ---
5
5
  <GenerationInfo sourceFile="packages/core/src/health-check/typeorm-health-check-strategy.ts" sourceLine="38" packageName="@vendure/core" />
6
6
 
7
- A <DocsLink href="/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy">HealthCheckStrategy</DocsLink> used to check the health of the database. This health
7
+ A [HealthCheckStrategy](/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy) used to check the health of the database. This health
8
8
  check is included by default, but can be customized by explicitly adding it to the
9
9
  `systemOptions.healthChecks` array:
10
10
 
@@ -33,7 +33,7 @@ class TypeORMHealthCheckStrategy implements HealthCheckStrategy {
33
33
  getHealthIndicator() => HealthIndicatorFunction;
34
34
  }
35
35
  ```
36
- * Implements: <DocsLink href="/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy">`HealthCheckStrategy`</DocsLink>
36
+ * Implements: [`HealthCheckStrategy`](/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy)
37
37
 
38
38
 
39
39
 
@@ -5,9 +5,9 @@ generated: true
5
5
  <GenerationInfo sourceFile="packages/core/src/config/asset-import-strategy/asset-import-strategy.ts" sourceLine="25" packageName="@vendure/core" since="1.7.0" />
6
6
 
7
7
  The AssetImportStrategy determines how asset files get imported based on the path given in the
8
- import CSV or via the <DocsLink href="/reference/typescript-api/import-export/asset-importer#assetimporter">AssetImporter</DocsLink> `getAssets()` method.
8
+ import CSV or via the [AssetImporter](/reference/typescript-api/import-export/asset-importer#assetimporter) `getAssets()` method.
9
9
 
10
- The <DocsLink href="/reference/typescript-api/import-export/default-asset-import-strategy#defaultassetimportstrategy">DefaultAssetImportStrategy</DocsLink> is able to load files from either the local filesystem
10
+ The [DefaultAssetImportStrategy](/reference/typescript-api/import-export/default-asset-import-strategy#defaultassetimportstrategy) is able to load files from either the local filesystem
11
11
  or from a remote URL.
12
12
 
13
13
  A custom strategy could be created which could e.g. get the asset file from an S3 bucket.
@@ -24,7 +24,7 @@ interface AssetImportStrategy extends InjectableStrategy {
24
24
  getStreamFromPath(assetPath: string): Readable | Promise<Readable>;
25
25
  }
26
26
  ```
27
- * Extends: <DocsLink href="/reference/typescript-api/common/injectable-strategy#injectablestrategy">`InjectableStrategy`</DocsLink>
27
+ * Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
28
28
 
29
29
 
30
30
 
@@ -4,9 +4,9 @@ generated: true
4
4
  ---
5
5
  <GenerationInfo sourceFile="packages/core/src/data-import/providers/asset-importer/asset-importer.ts" sourceLine="17" packageName="@vendure/core" />
6
6
 
7
- This service creates new <DocsLink href="/reference/typescript-api/entities/asset#asset">Asset</DocsLink> entities based on string paths provided in the CSV
7
+ This service creates new [Asset](/reference/typescript-api/entities/asset#asset) entities based on string paths provided in the CSV
8
8
  import format. The source files are resolved by joining the value of `importExportOptions.importAssetsDir`
9
- with the asset path. This service is used internally by the <DocsLink href="/reference/typescript-api/import-export/importer#importer">Importer</DocsLink> service.
9
+ with the asset path. This service is used internally by the [Importer](/reference/typescript-api/import-export/importer#importer) service.
10
10
 
11
11
  ```ts title="Signature"
12
12
  class AssetImporter {
@@ -17,7 +17,7 @@ class DefaultAssetImportStrategy implements AssetImportStrategy {
17
17
  getStreamFromPath(assetPath: string) => ;
18
18
  }
19
19
  ```
20
- * Implements: <DocsLink href="/reference/typescript-api/import-export/asset-import-strategy#assetimportstrategy">`AssetImportStrategy`</DocsLink>
20
+ * Implements: [`AssetImportStrategy`](/reference/typescript-api/import-export/asset-import-strategy#assetimportstrategy)
21
21
 
22
22
 
23
23
 
@@ -25,7 +25,7 @@ The directory in which assets to be imported are located.
25
25
  <MemberInfo kind="property" type={`<a href='/reference/typescript-api/import-export/asset-import-strategy#assetimportstrategy'>AssetImportStrategy</a>`} since="1.7.0" />
26
26
 
27
27
  This strategy determines how asset files get imported based on the path given in the
28
- import CSV or via the <DocsLink href="/reference/typescript-api/import-export/asset-importer#assetimporter">AssetImporter</DocsLink> `getAssets()` method.
28
+ import CSV or via the [AssetImporter](/reference/typescript-api/import-export/asset-importer#assetimporter) `getAssets()` method.
29
29
 
30
30
 
31
31
  </div>
@@ -5,7 +5,7 @@ generated: true
5
5
  <GenerationInfo sourceFile="packages/core/src/data-import/providers/import-parser/import-parser.ts" sourceLine="152" packageName="@vendure/core" />
6
6
 
7
7
  Validates and parses CSV files into a data structure which can then be used to created new entities.
8
- This is used internally by the <DocsLink href="/reference/typescript-api/import-export/importer#importer">Importer</DocsLink>.
8
+ This is used internally by the [Importer](/reference/typescript-api/import-export/importer#importer).
9
9
 
10
10
  ```ts title="Signature"
11
11
  class ImportParser {
@@ -20,14 +20,14 @@ class ImportParser {
20
20
  <MemberInfo kind="method" type={`(input: string | Stream, mainLanguage: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a> = this.configService.defaultLanguageCode) => Promise<<a href='/reference/typescript-api/import-export/import-parser#parseresult'>ParseResult</a><<a href='/reference/typescript-api/import-export/import-parser#parsedproductwithvariants'>ParsedProductWithVariants</a>>>`} />
21
21
 
22
22
  Parses the contents of the [product import CSV file](/developer-guide/importing-data/#product-import-format) and
23
- returns a data structure which can then be used to populate Vendure using the <DocsLink href="/reference/typescript-api/import-export/fast-importer-service#fastimporterservice">FastImporterService</DocsLink>.
23
+ returns a data structure which can then be used to populate Vendure using the [FastImporterService](/reference/typescript-api/import-export/fast-importer-service#fastimporterservice).
24
24
 
25
25
 
26
26
  </div>
27
27
  <GenerationInfo sourceFile="packages/core/src/data-import/providers/import-parser/import-parser.ts" sourceLine="45" packageName="@vendure/core" />
28
28
 
29
29
  The intermediate representation of an OptionGroup after it has been parsed
30
- by the <DocsLink href="/reference/typescript-api/import-export/import-parser#importparser">ImportParser</DocsLink>.
30
+ by the [ImportParser](/reference/typescript-api/import-export/import-parser#importparser).
31
31
 
32
32
  ```ts title="Signature"
33
33
  interface ParsedOptionGroup {
@@ -52,7 +52,7 @@ interface ParsedOptionGroup {
52
52
  <GenerationInfo sourceFile="packages/core/src/data-import/providers/import-parser/import-parser.ts" sourceLine="61" packageName="@vendure/core" />
53
53
 
54
54
  The intermediate representation of a Facet after it has been parsed
55
- by the <DocsLink href="/reference/typescript-api/import-export/import-parser#importparser">ImportParser</DocsLink>.
55
+ by the [ImportParser](/reference/typescript-api/import-export/import-parser#importparser).
56
56
 
57
57
  ```ts title="Signature"
58
58
  interface ParsedFacet {
@@ -77,7 +77,7 @@ interface ParsedFacet {
77
77
  <GenerationInfo sourceFile="packages/core/src/data-import/providers/import-parser/import-parser.ts" sourceLine="77" packageName="@vendure/core" />
78
78
 
79
79
  The intermediate representation of a ProductVariant after it has been parsed
80
- by the <DocsLink href="/reference/typescript-api/import-export/import-parser#importparser">ImportParser</DocsLink>.
80
+ by the [ImportParser](/reference/typescript-api/import-export/import-parser#importparser).
81
81
 
82
82
  ```ts title="Signature"
83
83
  interface ParsedProductVariant {
@@ -146,7 +146,7 @@ interface ParsedProductVariant {
146
146
  <GenerationInfo sourceFile="packages/core/src/data-import/providers/import-parser/import-parser.ts" sourceLine="102" packageName="@vendure/core" />
147
147
 
148
148
  The intermediate representation of a Product after it has been parsed
149
- by the <DocsLink href="/reference/typescript-api/import-export/import-parser#importparser">ImportParser</DocsLink>.
149
+ by the [ImportParser](/reference/typescript-api/import-export/import-parser#importparser).
150
150
 
151
151
  ```ts title="Signature"
152
152
  interface ParsedProduct {
@@ -193,7 +193,7 @@ interface ParsedProduct {
193
193
  <GenerationInfo sourceFile="packages/core/src/data-import/providers/import-parser/import-parser.ts" sourceLine="125" packageName="@vendure/core" />
194
194
 
195
195
  The data structure into which an import CSV file is parsed by the
196
- <DocsLink href="/reference/typescript-api/import-export/import-parser#importparser">ImportParser</DocsLink> `parseProducts()` method.
196
+ [ImportParser](/reference/typescript-api/import-export/import-parser#importparser) `parseProducts()` method.
197
197
 
198
198
  ```ts title="Signature"
199
199
  interface ParsedProductWithVariants {
@@ -219,7 +219,7 @@ interface ParsedProductWithVariants {
219
219
  </div>
220
220
  <GenerationInfo sourceFile="packages/core/src/data-import/providers/import-parser/import-parser.ts" sourceLine="137" packageName="@vendure/core" />
221
221
 
222
- The result returned by the <DocsLink href="/reference/typescript-api/import-export/import-parser#importparser">ImportParser</DocsLink> `parseProducts()` method.
222
+ The result returned by the [ImportParser](/reference/typescript-api/import-export/import-parser#importparser) `parseProducts()` method.
223
223
 
224
224
  ```ts title="Signature"
225
225
  interface ParseResult<T> {
@@ -6,8 +6,8 @@ generated: true
6
6
 
7
7
  Parses and imports Products using the CSV import format.
8
8
 
9
- Internally it is using the <DocsLink href="/reference/typescript-api/import-export/import-parser#importparser">ImportParser</DocsLink> to parse the CSV file, and then the
10
- <DocsLink href="/reference/typescript-api/import-export/fast-importer-service#fastimporterservice">FastImporterService</DocsLink> and the <DocsLink href="/reference/typescript-api/import-export/asset-importer#assetimporter">AssetImporter</DocsLink> to actually create the resulting
9
+ Internally it is using the [ImportParser](/reference/typescript-api/import-export/import-parser#importparser) to parse the CSV file, and then the
10
+ [FastImporterService](/reference/typescript-api/import-export/fast-importer-service#fastimporterservice) and the [AssetImporter](/reference/typescript-api/import-export/asset-importer#assetimporter) to actually create the resulting
11
11
  entities in the Vendure database.
12
12
 
13
13
  ```ts title="Signature"
@@ -14,9 +14,9 @@ The argument can be either a Channel object or a valid channel `token`.
14
14
 
15
15
  Internally the `populate()` function does the following:
16
16
 
17
- 1. Uses the <DocsLink href="/reference/typescript-api/import-export/populator#populator">Populator</DocsLink> to populate the <DocsLink href="/reference/typescript-api/import-export/initial-data#initialdata">InitialData</DocsLink>.
18
- 2. If `productsCsvPath` is provided, uses <DocsLink href="/reference/typescript-api/import-export/importer#importer">Importer</DocsLink> to populate Product data.
19
- 3. Uses <DocsLink href="/reference/typescript-api/import-export/populator#populator">Populator</DocsLink> to populate collections specified in the <DocsLink href="/reference/typescript-api/import-export/initial-data#initialdata">InitialData</DocsLink>.
17
+ 1. Uses the [Populator](/reference/typescript-api/import-export/populator#populator) to populate the [InitialData](/reference/typescript-api/import-export/initial-data#initialdata).
18
+ 2. If `productsCsvPath` is provided, uses [Importer](/reference/typescript-api/import-export/importer#importer) to populate Product data.
19
+ 3. Uses [Populator](/reference/typescript-api/import-export/populator#populator) to populate collections specified in the [InitialData](/reference/typescript-api/import-export/initial-data#initialdata).
20
20
 
21
21
  *Example*
22
22
 
@@ -4,7 +4,7 @@ generated: true
4
4
  ---
5
5
  <GenerationInfo sourceFile="packages/core/src/data-import/providers/populator/populator.ts" sourceLine="46" packageName="@vendure/core" />
6
6
 
7
- Responsible for populating the database with <DocsLink href="/reference/typescript-api/import-export/initial-data#initialdata">InitialData</DocsLink>, i.e. non-product data such as countries, tax rates,
7
+ Responsible for populating the database with [InitialData](/reference/typescript-api/import-export/initial-data#initialdata), i.e. non-product data such as countries, tax rates,
8
8
  shipping methods, payment methods & roles.
9
9
 
10
10
  ```ts title="Signature"
@@ -21,7 +21,7 @@ class Populator {
21
21
  <MemberInfo kind="method" type={`(data: <a href='/reference/typescript-api/import-export/initial-data#initialdata'>InitialData</a>, channel?: <a href='/reference/typescript-api/entities/channel#channel'>Channel</a>) => `} />
22
22
 
23
23
  Should be run *before* populating the products, so that there are TaxRates by which
24
- product prices can be set. If the `channel` argument is set, then any <DocsLink href="/reference/typescript-api/entities/interfaces#channelaware">ChannelAware</DocsLink>entities will be assigned to that Channel.
24
+ product prices can be set. If the `channel` argument is set, then any [ChannelAware](/reference/typescript-api/entities/interfaces#channelaware)entities will be assigned to that Channel.
25
25
  ### populateCollections
26
26
 
27
27
  <MemberInfo kind="method" type={`(data: <a href='/reference/typescript-api/import-export/initial-data#initialdata'>InitialData</a>, channel?: <a href='/reference/typescript-api/entities/channel#channel'>Channel</a>) => `} />
@@ -4,7 +4,7 @@ generated: true
4
4
  ---
5
5
  <GenerationInfo sourceFile="packages/core/src/plugin/default-job-queue-plugin/default-job-queue-plugin.ts" sourceLine="127" packageName="@vendure/core" />
6
6
 
7
- A plugin which configures Vendure to use the SQL database to persist the JobQueue jobs using the <DocsLink href="/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy">SqlJobQueueStrategy</DocsLink>. If you add this
7
+ A plugin which configures Vendure to use the SQL database to persist the JobQueue jobs using the [SqlJobQueueStrategy](/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy). If you add this
8
8
  plugin to an existing Vendure installation, you'll need to run a [database migration](/developer-guide/migrations), since this
9
9
  plugin will add a new "job_record" table to the database.
10
10
 
@@ -23,7 +23,7 @@ export const config: VendureConfig = {
23
23
 
24
24
  ## Configuration
25
25
 
26
- It is possible to configure the behaviour of the <DocsLink href="/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy">SqlJobQueueStrategy</DocsLink> by passing options to the static `init()` function:
26
+ It is possible to configure the behaviour of the [SqlJobQueueStrategy](/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy) by passing options to the static `init()` function:
27
27
 
28
28
  ### pollInterval
29
29
  The interval in ms between polling for new jobs. The default is 200ms.
@@ -133,13 +133,13 @@ class DefaultJobQueuePlugin {
133
133
  </div>
134
134
  <GenerationInfo sourceFile="packages/core/src/plugin/default-job-queue-plugin/clean-jobs-task.ts" sourceLine="18" packageName="@vendure/core" since="3.3.0" />
135
135
 
136
- A <DocsLink href="/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtask">ScheduledTask</DocsLink> that cleans up old jobs from the database when using the DefaultJobQueuePlugin.
137
- You can configure the settings & schedule of the task via the <DocsLink href="/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin">DefaultJobQueuePlugin</DocsLink> options.
136
+ A [ScheduledTask](/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtask) that cleans up old jobs from the database when using the DefaultJobQueuePlugin.
137
+ You can configure the settings & schedule of the task via the [DefaultJobQueuePlugin](/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin) options.
138
138
 
139
139
  <GenerationInfo sourceFile="packages/core/src/plugin/default-job-queue-plugin/types.ts" sourceLine="12" packageName="@vendure/core" />
140
140
 
141
141
  Configuration options for the DefaultJobQueuePlugin. These values get passed into the
142
- <DocsLink href="/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy">SqlJobQueueStrategy</DocsLink>.
142
+ [SqlJobQueueStrategy](/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy).
143
143
 
144
144
  ```ts title="Signature"
145
145
  interface DefaultJobQueueOptions {
@@ -4,12 +4,12 @@ generated: true
4
4
  ---
5
5
  <GenerationInfo sourceFile="packages/core/src/job-queue/job-buffer/in-memory-job-buffer-storage-strategy.ts" sourceLine="17" packageName="@vendure/core" since="1.3.0" />
6
6
 
7
- A <DocsLink href="/reference/typescript-api/job-queue/job-buffer-storage-strategy#jobbufferstoragestrategy">JobBufferStorageStrategy</DocsLink> which keeps the buffered jobs in memory. Should
7
+ A [JobBufferStorageStrategy](/reference/typescript-api/job-queue/job-buffer-storage-strategy#jobbufferstoragestrategy) which keeps the buffered jobs in memory. Should
8
8
  _not_ be used in production, since it will lose data in the event of the server
9
9
  stopping.
10
10
 
11
- Instead, use the <DocsLink href="/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin">DefaultJobQueuePlugin</DocsLink> with the `useDatabaseForBuffer: true` option set,
12
- or the <DocsLink href="/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-plugin#bullmqjobqueueplugin">BullMQJobQueuePlugin</DocsLink> or another custom strategy with persistent storage.
11
+ Instead, use the [DefaultJobQueuePlugin](/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin) with the `useDatabaseForBuffer: true` option set,
12
+ or the [BullMQJobQueuePlugin](/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-plugin#bullmqjobqueueplugin) or another custom strategy with persistent storage.
13
13
 
14
14
  ```ts title="Signature"
15
15
  class InMemoryJobBufferStorageStrategy implements JobBufferStorageStrategy {
@@ -19,7 +19,7 @@ class InMemoryJobBufferStorageStrategy implements JobBufferStorageStrategy {
19
19
  flush(bufferIds?: string[]) => Promise<{ [bufferId: string]: Job[] }>;
20
20
  }
21
21
  ```
22
- * Implements: <DocsLink href="/reference/typescript-api/job-queue/job-buffer-storage-strategy#jobbufferstoragestrategy">`JobBufferStorageStrategy`</DocsLink>
22
+ * Implements: [`JobBufferStorageStrategy`](/reference/typescript-api/job-queue/job-buffer-storage-strategy#jobbufferstoragestrategy)
23
23
 
24
24
 
25
25
 
@@ -4,8 +4,8 @@ generated: true
4
4
  ---
5
5
  <GenerationInfo sourceFile="packages/core/src/job-queue/in-memory-job-queue-strategy.ts" sourceLine="42" packageName="@vendure/core" />
6
6
 
7
- An in-memory <DocsLink href="/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy">JobQueueStrategy</DocsLink>. This is the default strategy if not using a dedicated
8
- JobQueue plugin (e.g. <DocsLink href="/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin">DefaultJobQueuePlugin</DocsLink>). Not recommended for production, since
7
+ An in-memory [JobQueueStrategy](/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy). This is the default strategy if not using a dedicated
8
+ JobQueue plugin (e.g. [DefaultJobQueuePlugin](/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin)). Not recommended for production, since
9
9
  the queue will be cleared when the server stops, and can only be used when the JobQueueService is
10
10
  started from the main server process:
11
11
 
@@ -36,10 +36,10 @@ class InMemoryJobQueueStrategy extends PollingJobQueueStrategy implements Inspec
36
36
  removeSettledJobs(queueNames: string[] = [], olderThan?: Date) => Promise<number>;
37
37
  }
38
38
  ```
39
- * Extends: <DocsLink href="/reference/typescript-api/job-queue/polling-job-queue-strategy#pollingjobqueuestrategy">`PollingJobQueueStrategy`</DocsLink>
39
+ * Extends: [`PollingJobQueueStrategy`](/reference/typescript-api/job-queue/polling-job-queue-strategy#pollingjobqueuestrategy)
40
40
 
41
41
 
42
- * Implements: <DocsLink href="/reference/typescript-api/job-queue/inspectable-job-queue-strategy#inspectablejobqueuestrategy">`InspectableJobQueueStrategy`</DocsLink>
42
+ * Implements: [`InspectableJobQueueStrategy`](/reference/typescript-api/job-queue/inspectable-job-queue-strategy#inspectablejobqueuestrategy)
43
43
 
44
44
 
45
45
 
@@ -4,12 +4,12 @@ generated: true
4
4
  ---
5
5
  <GenerationInfo sourceFile="packages/core/src/job-queue/job-queue.ts" sourceLine="21" packageName="@vendure/core" />
6
6
 
7
- A JobQueue is used to process <DocsLink href="/reference/typescript-api/job-queue/job#job">Job</DocsLink>s. A job is added to the queue via the
8
- `.add()` method, and the configured <DocsLink href="/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy">JobQueueStrategy</DocsLink> will check for new jobs and process each
7
+ A JobQueue is used to process [Job](/reference/typescript-api/job-queue/job#job)s. A job is added to the queue via the
8
+ `.add()` method, and the configured [JobQueueStrategy](/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy) will check for new jobs and process each
9
9
  according to the defined `process` function.
10
10
 
11
11
  *Note*: JobQueue instances should not be directly instantiated. Rather, the
12
- <DocsLink href="/reference/typescript-api/job-queue/job-queue-service#jobqueueservice">JobQueueService</DocsLink> `createQueue()` method should be used (see that service
12
+ [JobQueueService](/reference/typescript-api/job-queue/job-queue-service#jobqueueservice) `createQueue()` method should be used (see that service
13
13
  for example usage).
14
14
 
15
15
  ```ts title="Signature"
@@ -42,7 +42,7 @@ class JobQueue<Data extends JobData<Data> = object> {
42
42
 
43
43
  <MemberInfo kind="method" type={`(data: Data, options?: JobOptions<Data>) => Promise<<a href='/reference/typescript-api/job-queue/subscribable-job#subscribablejob'>SubscribableJob</a><Data>>`} />
44
44
 
45
- Adds a new <DocsLink href="/reference/typescript-api/job-queue/job#job">Job</DocsLink> to the queue. The resolved <DocsLink href="/reference/typescript-api/job-queue/subscribable-job#subscribablejob">SubscribableJob</DocsLink> allows the
45
+ Adds a new [Job](/reference/typescript-api/job-queue/job#job) to the queue. The resolved [SubscribableJob](/reference/typescript-api/job-queue/subscribable-job#subscribablejob) allows the
46
46
  calling code to subscribe to updates to the Job:
47
47
 
48
48
  *Example*
@@ -15,7 +15,7 @@ interface InspectableJobQueueStrategy extends JobQueueStrategy {
15
15
  cancelJob(jobId: ID): Promise<Job | undefined>;
16
16
  }
17
17
  ```
18
- * Extends: <DocsLink href="/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy">`JobQueueStrategy`</DocsLink>
18
+ * Extends: [`JobQueueStrategy`](/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy)
19
19
 
20
20
 
21
21
 
@@ -5,7 +5,7 @@ generated: true
5
5
  <GenerationInfo sourceFile="packages/core/src/job-queue/job-buffer/job-buffer-storage-strategy.ts" sourceLine="19" packageName="@vendure/core" since="1.3.0" />
6
6
 
7
7
  This strategy defines where to store jobs that have been collected by a
8
- <DocsLink href="/reference/typescript-api/job-queue/job-buffer#jobbuffer">JobBuffer</DocsLink>.
8
+ [JobBuffer](/reference/typescript-api/job-queue/job-buffer#jobbuffer).
9
9
 
10
10
  :::info
11
11
 
@@ -21,7 +21,7 @@ interface JobBufferStorageStrategy extends InjectableStrategy {
21
21
  flush(bufferIds?: string[]): Promise<{ [bufferId: string]: Job[] }>;
22
22
  }
23
23
  ```
24
- * Extends: <DocsLink href="/reference/typescript-api/common/injectable-strategy#injectablestrategy">`InjectableStrategy`</DocsLink>
24
+ * Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
25
25
 
26
26
 
27
27
 
@@ -7,7 +7,7 @@ generated: true
7
7
  A JobBuffer is used to temporarily prevent jobs from being sent to the job queue for processing.
8
8
  Instead, it collects certain jobs (as specified by the `collect()` method), and stores them.
9
9
 
10
- How these buffered jobs are stored is determined by the configured <DocsLink href="/reference/typescript-api/job-queue/job-buffer-storage-strategy#jobbufferstoragestrategy">JobBufferStorageStrategy</DocsLink>.
10
+ How these buffered jobs are stored is determined by the configured [JobBufferStorageStrategy](/reference/typescript-api/job-queue/job-buffer-storage-strategy#jobbufferstoragestrategy).
11
11
 
12
12
  The JobBuffer can be thought of as a kind of "interceptor" of jobs. That is, when a JobBuffer is active,
13
13
  it sits in between calls to `JobQueue.add()` and the actual adding of the job to the queue.
@@ -58,7 +58,7 @@ export class CollectionJobBuffer implements JobBuffer<ApplyCollectionFiltersJobD
58
58
  }
59
59
  ```
60
60
 
61
- A JobBuffer is used by adding it to the <DocsLink href="/reference/typescript-api/job-queue/job-queue-service#jobqueueservice">JobQueueService</DocsLink>, at which point it will become active
61
+ A JobBuffer is used by adding it to the [JobQueueService](/reference/typescript-api/job-queue/job-queue-service#jobqueueservice), at which point it will become active
62
62
  and start collecting jobs.
63
63
 
64
64
  At some later point, the buffer can be flushed, causing the buffered jobs to be passed through the
@@ -4,7 +4,7 @@ generated: true
4
4
  ---
5
5
  <GenerationInfo sourceFile="packages/core/src/job-queue/job-queue.service.ts" sourceLine="49" packageName="@vendure/core" />
6
6
 
7
- The JobQueueService is used to create new <DocsLink href="/reference/typescript-api/job-queue/#jobqueue">JobQueue</DocsLink> instances and access
7
+ The JobQueueService is used to create new [JobQueue](/reference/typescript-api/job-queue/#jobqueue) instances and access
8
8
  existing jobs.
9
9
 
10
10
  *Example*
@@ -63,7 +63,7 @@ class JobQueueService implements OnModuleDestroy {
63
63
 
64
64
  <MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/job-queue/types#createqueueoptions'>CreateQueueOptions</a><Data>) => Promise<<a href='/reference/typescript-api/job-queue/#jobqueue'>JobQueue</a><Data>>`} />
65
65
 
66
- Configures and creates a new <DocsLink href="/reference/typescript-api/job-queue/#jobqueue">JobQueue</DocsLink> instance.
66
+ Configures and creates a new [JobQueue](/reference/typescript-api/job-queue/#jobqueue) instance.
67
67
  ### start
68
68
 
69
69
  <MemberInfo kind="method" type={`() => Promise<void>`} />
@@ -73,13 +73,13 @@ Configures and creates a new <DocsLink href="/reference/typescript-api/job-queue
73
73
 
74
74
  <MemberInfo kind="method" type={`(buffer: <a href='/reference/typescript-api/job-queue/job-buffer#jobbuffer'>JobBuffer</a><any>) => `} since="1.3.0" />
75
75
 
76
- Adds a <DocsLink href="/reference/typescript-api/job-queue/job-buffer#jobbuffer">JobBuffer</DocsLink>, which will make it active and begin collecting
76
+ Adds a [JobBuffer](/reference/typescript-api/job-queue/job-buffer#jobbuffer), which will make it active and begin collecting
77
77
  jobs to buffer.
78
78
  ### removeBuffer
79
79
 
80
80
  <MemberInfo kind="method" type={`(buffer: <a href='/reference/typescript-api/job-queue/job-buffer#jobbuffer'>JobBuffer</a><any>) => `} since="1.3.0" />
81
81
 
82
- Removes a <DocsLink href="/reference/typescript-api/job-queue/job-buffer#jobbuffer">JobBuffer</DocsLink>, prevent it from collecting and buffering any
82
+ Removes a [JobBuffer](/reference/typescript-api/job-queue/job-buffer#jobbuffer), prevent it from collecting and buffering any
83
83
  subsequent jobs.
84
84
  ### bufferSize
85
85
 
@@ -4,7 +4,7 @@ generated: true
4
4
  ---
5
5
  <GenerationInfo sourceFile="packages/core/src/config/job-queue/job-queue-strategy.ts" sourceLine="24" packageName="@vendure/core" />
6
6
 
7
- Defines how the jobs in the <DocsLink href="/reference/typescript-api/job-queue/job-queue-service#jobqueueservice">JobQueueService</DocsLink> are persisted and
7
+ Defines how the jobs in the [JobQueueService](/reference/typescript-api/job-queue/job-queue-service#jobqueueservice) are persisted and
8
8
  accessed. Custom strategies can be defined to make use of external
9
9
  services such as Redis.
10
10
 
@@ -28,7 +28,7 @@ interface JobQueueStrategy extends InjectableStrategy {
28
28
  ): Promise<void>;
29
29
  }
30
30
  ```
31
- * Extends: <DocsLink href="/reference/typescript-api/common/injectable-strategy#injectablestrategy">`InjectableStrategy`</DocsLink>
31
+ * Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
32
32
 
33
33
 
34
34
 
@@ -6,7 +6,7 @@ generated: true
6
6
 
7
7
  A Job represents a piece of work to be run in the background, i.e. outside the request-response cycle.
8
8
  It is intended to be used for long-running work triggered by API requests. Jobs should now generally
9
- be directly instantiated. Rather, the <DocsLink href="/reference/typescript-api/job-queue/#jobqueue">JobQueue</DocsLink> `add()` method should be used to create and
9
+ be directly instantiated. Rather, the [JobQueue](/reference/typescript-api/job-queue/#jobqueue) `add()` method should be used to create and
10
10
  add a new Job to a queue.
11
11
 
12
12
  ```ts title="Signature"
@@ -125,7 +125,7 @@ class Job<T extends JobData<T> = any> {
125
125
  <MemberInfo kind="method" type={`() => `} />
126
126
 
127
127
  Calling this signifies that the job work has started. This method should be
128
- called in the <DocsLink href="/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy">JobQueueStrategy</DocsLink> `next()` method.
128
+ called in the [JobQueueStrategy](/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy) `next()` method.
129
129
  ### setProgress
130
130
 
131
131
  <MemberInfo kind="method" type={`(percent: number) => `} />