@vendure/docs 0.0.0-202601211609 → 0.0.0-202601220950

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 (371) hide show
  1. package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +1 -1
  2. package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +2 -2
  3. package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +3 -3
  4. package/docs/reference/admin-ui-api/alerts/alert-config.mdx +5 -5
  5. package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +5 -5
  6. package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +3 -3
  7. package/docs/reference/admin-ui-api/components/currency-input-component.mdx +4 -4
  8. package/docs/reference/admin-ui-api/components/data-table-component.mdx +5 -5
  9. package/docs/reference/admin-ui-api/components/data-table2component.mdx +7 -7
  10. package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +7 -7
  11. package/docs/reference/admin-ui-api/components/dropdown-component.mdx +1 -1
  12. package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +6 -6
  13. package/docs/reference/admin-ui-api/components/object-tree-component.mdx +1 -1
  14. package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx +1 -1
  15. package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +2 -2
  16. package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +3 -3
  17. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +1 -1
  18. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.mdx +1 -1
  19. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +4 -4
  20. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -1
  21. package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +22 -22
  22. package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +1 -1
  23. package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +1 -1
  24. package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.mdx +1 -1
  25. package/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx +1 -1
  26. package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +1 -1
  27. package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +6 -6
  28. package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +1 -1
  29. package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +8 -8
  30. package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -1
  31. package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +2 -2
  32. package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +6 -6
  33. package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx +3 -3
  34. package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -1
  35. package/docs/reference/admin-ui-api/react-components/action-bar.mdx +1 -1
  36. package/docs/reference/admin-ui-api/react-components/card.mdx +1 -1
  37. package/docs/reference/admin-ui-api/react-components/cds-icon.mdx +1 -1
  38. package/docs/reference/admin-ui-api/react-components/form-field.mdx +1 -1
  39. package/docs/reference/admin-ui-api/react-components/link.mdx +1 -1
  40. package/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx +1 -1
  41. package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.mdx +1 -1
  42. package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +1 -1
  43. package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx +1 -1
  44. package/docs/reference/admin-ui-api/react-hooks/use-injector.mdx +1 -1
  45. package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx +1 -1
  46. package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx +1 -1
  47. package/docs/reference/admin-ui-api/react-hooks/use-query.mdx +1 -1
  48. package/docs/reference/admin-ui-api/routes/register-route-component.mdx +1 -1
  49. package/docs/reference/admin-ui-api/services/data-service.mdx +10 -10
  50. package/docs/reference/admin-ui-api/services/modal-service.mdx +5 -5
  51. package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx +1 -1
  52. package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +1 -1
  53. package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
  54. package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +1 -1
  55. package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +2 -2
  56. package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
  57. package/docs/reference/core-plugins/asset-server-plugin/index.mdx +1 -1
  58. package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +8 -8
  59. package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +1 -1
  60. package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +2 -2
  61. package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +1 -1
  62. package/docs/reference/core-plugins/dashboard-plugin/index.mdx +1 -1
  63. package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +8 -8
  64. package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
  65. package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +1 -1
  66. package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +13 -13
  67. package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
  68. package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
  69. package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +2 -2
  70. package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +1 -1
  71. package/docs/reference/core-plugins/email-plugin/email-sender.mdx +1 -1
  72. package/docs/reference/core-plugins/email-plugin/index.mdx +1 -1
  73. package/docs/reference/core-plugins/email-plugin/template-loader.mdx +4 -4
  74. package/docs/reference/core-plugins/email-plugin/transport-options.mdx +1 -1
  75. package/docs/reference/core-plugins/graphiql-plugin/index.mdx +2 -2
  76. package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -1
  77. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +9 -9
  78. package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +5 -5
  79. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +3 -3
  80. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx +1 -1
  81. package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx +2 -2
  82. package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx +1 -1
  83. package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +5 -5
  84. package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +4 -4
  85. package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx +1 -1
  86. package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx +1 -1
  87. package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +2 -2
  88. package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -1
  89. package/docs/reference/dashboard/components/asset-gallery.mdx +3 -3
  90. package/docs/reference/dashboard/components/asset-picker-dialog.mdx +2 -2
  91. package/docs/reference/dashboard/components/channel-chip.mdx +1 -1
  92. package/docs/reference/dashboard/components/detail-page-button.mdx +1 -1
  93. package/docs/reference/dashboard/components/facet-value-selector.mdx +1 -1
  94. package/docs/reference/dashboard/components/permission-guard.mdx +1 -1
  95. package/docs/reference/dashboard/components/vendure-image.mdx +1 -1
  96. package/docs/reference/dashboard/detail-views/detail-page.mdx +3 -3
  97. package/docs/reference/dashboard/detail-views/use-detail-page.mdx +11 -11
  98. package/docs/reference/dashboard/detail-views/use-generated-form.mdx +3 -3
  99. package/docs/reference/dashboard/extensions-api/action-bar.mdx +1 -1
  100. package/docs/reference/dashboard/extensions-api/alerts.mdx +6 -6
  101. package/docs/reference/dashboard/extensions-api/data-tables.mdx +1 -1
  102. package/docs/reference/dashboard/extensions-api/detail-forms.mdx +1 -1
  103. package/docs/reference/dashboard/extensions-api/history-entries.mdx +2 -2
  104. package/docs/reference/dashboard/extensions-api/page-blocks.mdx +2 -2
  105. package/docs/reference/dashboard/extensions-api/routes.mdx +4 -4
  106. package/docs/reference/dashboard/extensions-api/widgets.mdx +1 -1
  107. package/docs/reference/dashboard/form-components/affixed-input.mdx +1 -1
  108. package/docs/reference/dashboard/form-components/boolean-input.mdx +1 -1
  109. package/docs/reference/dashboard/form-components/checkbox-input.mdx +1 -1
  110. package/docs/reference/dashboard/form-components/date-time-input.mdx +1 -1
  111. package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
  112. package/docs/reference/dashboard/form-components/money-input.mdx +1 -1
  113. package/docs/reference/dashboard/form-components/number-input.mdx +1 -1
  114. package/docs/reference/dashboard/form-components/password-input.mdx +1 -1
  115. package/docs/reference/dashboard/form-components/rich-text-input.mdx +1 -1
  116. package/docs/reference/dashboard/form-components/textarea-input.mdx +1 -1
  117. package/docs/reference/dashboard/hooks/use-alerts.mdx +1 -1
  118. package/docs/reference/dashboard/hooks/use-auth.mdx +5 -5
  119. package/docs/reference/dashboard/hooks/use-channel.mdx +2 -2
  120. package/docs/reference/dashboard/hooks/use-drag-and-drop.mdx +1 -1
  121. package/docs/reference/dashboard/list-views/bulk-actions.mdx +3 -3
  122. package/docs/reference/dashboard/list-views/data-table.mdx +10 -10
  123. package/docs/reference/dashboard/list-views/list-page.mdx +13 -13
  124. package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +17 -17
  125. package/docs/reference/dashboard/page-layout/index.mdx +1 -1
  126. package/docs/reference/dashboard/page-layout/page-action-bar.mdx +3 -3
  127. package/docs/reference/dashboard/page-layout/page-block.mdx +3 -3
  128. package/docs/reference/dashboard/page-layout/page-title.mdx +1 -1
  129. package/docs/reference/dashboard/page-layout/page.mdx +2 -2
  130. package/docs/reference/graphql-api/admin/_index.mdx +11 -0
  131. package/docs/reference/graphql-api/shop/_index.mdx +11 -0
  132. package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
  133. package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +6 -6
  134. package/docs/reference/typescript-api/auth/auth-options.mdx +1 -1
  135. package/docs/reference/typescript-api/auth/authentication-strategy.mdx +2 -2
  136. package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +2 -2
  137. package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +4 -4
  138. package/docs/reference/typescript-api/auth/external-authentication-service.mdx +5 -5
  139. package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +2 -2
  140. package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +2 -2
  141. package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +1 -1
  142. package/docs/reference/typescript-api/auth/permission-definition.mdx +2 -2
  143. package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +4 -4
  144. package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +2 -2
  145. package/docs/reference/typescript-api/cache/cache-config.mdx +1 -1
  146. package/docs/reference/typescript-api/cache/cache-service.mdx +4 -4
  147. package/docs/reference/typescript-api/cache/cache-strategy.mdx +4 -4
  148. package/docs/reference/typescript-api/cache/index.mdx +3 -3
  149. package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +4 -4
  150. package/docs/reference/typescript-api/cache/request-context-cache-service.mdx +2 -2
  151. package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +6 -6
  152. package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +1 -1
  153. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx +1 -1
  154. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx +1 -1
  155. package/docs/reference/typescript-api/common/async-queue.mdx +1 -1
  156. package/docs/reference/typescript-api/common/bootstrap.mdx +2 -2
  157. package/docs/reference/typescript-api/common/injectable-strategy.mdx +2 -2
  158. package/docs/reference/typescript-api/common/injector.mdx +2 -2
  159. package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +1 -1
  160. package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx +11 -11
  161. package/docs/reference/typescript-api/configurable-operation-def/index.mdx +2 -2
  162. package/docs/reference/typescript-api/configuration/api-options.mdx +2 -2
  163. package/docs/reference/typescript-api/configuration/collection-filter.mdx +2 -2
  164. package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +4 -4
  165. package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +2 -2
  166. package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
  167. package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +1 -1
  168. package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +3 -3
  169. package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +14 -14
  170. package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
  171. package/docs/reference/typescript-api/configuration/vendure-config.mdx +2 -2
  172. package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +1 -1
  173. package/docs/reference/typescript-api/data-access/calculated.mdx +1 -1
  174. package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
  175. package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
  176. package/docs/reference/typescript-api/data-access/list-query-builder.mdx +4 -4
  177. package/docs/reference/typescript-api/data-access/transactional-connection.mdx +9 -9
  178. package/docs/reference/typescript-api/default-search-plugin/index.mdx +1 -1
  179. package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +4 -4
  180. package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +4 -4
  181. package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +4 -4
  182. package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +4 -4
  183. package/docs/reference/typescript-api/entities/address.mdx +1 -1
  184. package/docs/reference/typescript-api/entities/administrator.mdx +1 -1
  185. package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
  186. package/docs/reference/typescript-api/entities/asset.mdx +1 -1
  187. package/docs/reference/typescript-api/entities/authenticated-session.mdx +1 -1
  188. package/docs/reference/typescript-api/entities/authentication-method.mdx +2 -2
  189. package/docs/reference/typescript-api/entities/channel.mdx +1 -1
  190. package/docs/reference/typescript-api/entities/collection.mdx +2 -2
  191. package/docs/reference/typescript-api/entities/country.mdx +1 -1
  192. package/docs/reference/typescript-api/entities/customer-group.mdx +1 -1
  193. package/docs/reference/typescript-api/entities/customer-history-entry.mdx +1 -1
  194. package/docs/reference/typescript-api/entities/customer.mdx +1 -1
  195. package/docs/reference/typescript-api/entities/facet-value.mdx +2 -2
  196. package/docs/reference/typescript-api/entities/facet.mdx +2 -2
  197. package/docs/reference/typescript-api/entities/fulfillment.mdx +1 -1
  198. package/docs/reference/typescript-api/entities/global-settings.mdx +1 -1
  199. package/docs/reference/typescript-api/entities/interfaces.mdx +1 -1
  200. package/docs/reference/typescript-api/entities/order-history-entry.mdx +1 -1
  201. package/docs/reference/typescript-api/entities/order-line-reference.mdx +3 -3
  202. package/docs/reference/typescript-api/entities/order-line.mdx +1 -1
  203. package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
  204. package/docs/reference/typescript-api/entities/order.mdx +1 -1
  205. package/docs/reference/typescript-api/entities/orderable-asset.mdx +1 -1
  206. package/docs/reference/typescript-api/entities/payment-method.mdx +2 -2
  207. package/docs/reference/typescript-api/entities/payment.mdx +1 -1
  208. package/docs/reference/typescript-api/entities/product-option-group.mdx +2 -2
  209. package/docs/reference/typescript-api/entities/product-option.mdx +2 -2
  210. package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -1
  211. package/docs/reference/typescript-api/entities/product-variant.mdx +2 -2
  212. package/docs/reference/typescript-api/entities/product.mdx +2 -2
  213. package/docs/reference/typescript-api/entities/promotion.mdx +4 -4
  214. package/docs/reference/typescript-api/entities/province.mdx +1 -1
  215. package/docs/reference/typescript-api/entities/refund.mdx +1 -1
  216. package/docs/reference/typescript-api/entities/region.mdx +1 -1
  217. package/docs/reference/typescript-api/entities/role.mdx +1 -1
  218. package/docs/reference/typescript-api/entities/seller.mdx +1 -1
  219. package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
  220. package/docs/reference/typescript-api/entities/shipping-line.mdx +1 -1
  221. package/docs/reference/typescript-api/entities/shipping-method.mdx +4 -4
  222. package/docs/reference/typescript-api/entities/stock-level.mdx +1 -1
  223. package/docs/reference/typescript-api/entities/stock-location.mdx +1 -1
  224. package/docs/reference/typescript-api/entities/stock-movement.mdx +5 -5
  225. package/docs/reference/typescript-api/entities/surcharge.mdx +1 -1
  226. package/docs/reference/typescript-api/entities/tag.mdx +1 -1
  227. package/docs/reference/typescript-api/entities/tax-category.mdx +1 -1
  228. package/docs/reference/typescript-api/entities/tax-rate.mdx +1 -1
  229. package/docs/reference/typescript-api/entities/user.mdx +1 -1
  230. package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -1
  231. package/docs/reference/typescript-api/entities/zone.mdx +1 -1
  232. package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +2 -2
  233. package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx +2 -2
  234. package/docs/reference/typescript-api/events/event-bus.mdx +4 -4
  235. package/docs/reference/typescript-api/events/event-types.mdx +1 -1
  236. package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +3 -3
  237. package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +4 -4
  238. package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +1 -1
  239. package/docs/reference/typescript-api/import-export/asset-importer.mdx +1 -1
  240. package/docs/reference/typescript-api/import-export/fast-importer-service.mdx +4 -4
  241. package/docs/reference/typescript-api/import-export/import-parser.mdx +5 -5
  242. package/docs/reference/typescript-api/import-export/importer.mdx +3 -3
  243. package/docs/reference/typescript-api/import-export/initial-data.mdx +3 -3
  244. package/docs/reference/typescript-api/import-export/populate.mdx +1 -1
  245. package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -5
  246. package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +3 -3
  247. package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +8 -8
  248. package/docs/reference/typescript-api/job-queue/index.mdx +2 -2
  249. package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +5 -5
  250. package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +3 -3
  251. package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
  252. package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +6 -6
  253. package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +3 -3
  254. package/docs/reference/typescript-api/job-queue/job.mdx +3 -3
  255. package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +8 -8
  256. package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +6 -6
  257. package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +2 -2
  258. package/docs/reference/typescript-api/job-queue/types.mdx +1 -1
  259. package/docs/reference/typescript-api/migration/generate-migration.mdx +1 -1
  260. package/docs/reference/typescript-api/migration/revert-last-migration.mdx +1 -1
  261. package/docs/reference/typescript-api/migration/run-migrations.mdx +1 -1
  262. package/docs/reference/typescript-api/orders/active-order-service.mdx +6 -6
  263. package/docs/reference/typescript-api/orders/active-order-strategy.mdx +3 -3
  264. package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +1 -1
  265. package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +1 -1
  266. package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +1 -1
  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/order-by-code-access-strategy.mdx +1 -1
  270. package/docs/reference/typescript-api/orders/order-code-strategy.mdx +1 -1
  271. package/docs/reference/typescript-api/orders/order-interceptor.mdx +3 -3
  272. package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +1 -1
  273. package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
  274. package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
  275. package/docs/reference/typescript-api/orders/order-process.mdx +4 -4
  276. package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +3 -3
  277. package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
  278. package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +5 -5
  279. package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +2 -2
  280. package/docs/reference/typescript-api/payment/payment-method-handler.mdx +1 -1
  281. package/docs/reference/typescript-api/payment/payment-method-types.mdx +3 -3
  282. package/docs/reference/typescript-api/payment/payment-options.mdx +3 -3
  283. package/docs/reference/typescript-api/payment/payment-process.mdx +4 -4
  284. package/docs/reference/typescript-api/payment/refund-process.mdx +4 -4
  285. package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +4 -4
  286. package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
  287. package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
  288. package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +1 -1
  289. package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -2
  290. package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +1 -1
  291. package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
  292. package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +5 -5
  293. package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +1 -1
  294. package/docs/reference/typescript-api/promotions/promotion-action.mdx +12 -12
  295. package/docs/reference/typescript-api/promotions/promotion-condition.mdx +3 -3
  296. package/docs/reference/typescript-api/promotions/promotion-options.mdx +2 -2
  297. package/docs/reference/typescript-api/request/request-context-service.mdx +2 -2
  298. package/docs/reference/typescript-api/request/request-context.mdx +2 -2
  299. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +4 -4
  300. package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +4 -4
  301. package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +3 -3
  302. package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +5 -5
  303. package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +1 -1
  304. package/docs/reference/typescript-api/service-helpers/order-calculator.mdx +1 -1
  305. package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +3 -3
  306. package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -1
  307. package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +2 -2
  308. package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +2 -2
  309. package/docs/reference/typescript-api/service-helpers/translator-service.mdx +1 -1
  310. package/docs/reference/typescript-api/services/administrator-service.mdx +6 -6
  311. package/docs/reference/typescript-api/services/asset-service.mdx +13 -13
  312. package/docs/reference/typescript-api/services/auth-service.mdx +4 -4
  313. package/docs/reference/typescript-api/services/channel-service.mdx +12 -12
  314. package/docs/reference/typescript-api/services/collection-service.mdx +20 -20
  315. package/docs/reference/typescript-api/services/country-service.mdx +7 -7
  316. package/docs/reference/typescript-api/services/customer-group-service.mdx +8 -8
  317. package/docs/reference/typescript-api/services/customer-service.mdx +24 -24
  318. package/docs/reference/typescript-api/services/entity-slug-service.mdx +1 -1
  319. package/docs/reference/typescript-api/services/facet-service.mdx +11 -11
  320. package/docs/reference/typescript-api/services/facet-value-service.mdx +12 -12
  321. package/docs/reference/typescript-api/services/fulfillment-service.mdx +4 -4
  322. package/docs/reference/typescript-api/services/global-settings-service.mdx +2 -2
  323. package/docs/reference/typescript-api/services/history-service.mdx +8 -8
  324. package/docs/reference/typescript-api/services/order-service.mdx +52 -52
  325. package/docs/reference/typescript-api/services/order-testing-service.mdx +2 -2
  326. package/docs/reference/typescript-api/services/payment-method-service.mdx +10 -10
  327. package/docs/reference/typescript-api/services/payment-service.mdx +7 -7
  328. package/docs/reference/typescript-api/services/product-option-group-service.mdx +5 -5
  329. package/docs/reference/typescript-api/services/product-option-service.mdx +5 -5
  330. package/docs/reference/typescript-api/services/product-service.mdx +13 -13
  331. package/docs/reference/typescript-api/services/product-variant-service.mdx +22 -22
  332. package/docs/reference/typescript-api/services/promotion-service.mdx +9 -9
  333. package/docs/reference/typescript-api/services/province-service.mdx +5 -5
  334. package/docs/reference/typescript-api/services/role-service.mdx +11 -11
  335. package/docs/reference/typescript-api/services/search-service.mdx +2 -2
  336. package/docs/reference/typescript-api/services/seller-service.mdx +3 -3
  337. package/docs/reference/typescript-api/services/session-service.mdx +8 -8
  338. package/docs/reference/typescript-api/services/settings-store-service.mdx +15 -15
  339. package/docs/reference/typescript-api/services/shipping-method-service.mdx +8 -8
  340. package/docs/reference/typescript-api/services/slug-service.mdx +1 -1
  341. package/docs/reference/typescript-api/services/stock-level-service.mdx +3 -3
  342. package/docs/reference/typescript-api/services/stock-location-service.mdx +7 -7
  343. package/docs/reference/typescript-api/services/stock-movement-service.mdx +7 -7
  344. package/docs/reference/typescript-api/services/tag-service.mdx +5 -5
  345. package/docs/reference/typescript-api/services/tax-category-service.mdx +5 -5
  346. package/docs/reference/typescript-api/services/tax-rate-service.mdx +6 -6
  347. package/docs/reference/typescript-api/services/user-service.mdx +12 -12
  348. package/docs/reference/typescript-api/services/zone-service.mdx +8 -8
  349. package/docs/reference/typescript-api/settings-store/settings-store-field-config.mdx +2 -2
  350. package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +1 -1
  351. package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +2 -2
  352. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +2 -2
  353. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +1 -1
  354. package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +1 -1
  355. package/docs/reference/typescript-api/shipping/shipping-options.mdx +5 -5
  356. package/docs/reference/typescript-api/state-machine/fsm.mdx +2 -2
  357. package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +4 -4
  358. package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +1 -1
  359. package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +1 -1
  360. package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +2 -2
  361. package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -1
  362. package/docs/reference/typescript-api/testing/create-test-environment.mdx +1 -1
  363. package/docs/reference/typescript-api/testing/error-result-guard.mdx +1 -1
  364. package/docs/reference/typescript-api/testing/register-initializer.mdx +1 -1
  365. package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx +5 -5
  366. package/docs/reference/typescript-api/testing/test-db-initializer.mdx +3 -3
  367. package/docs/reference/typescript-api/testing/test-server.mdx +2 -2
  368. package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
  369. package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -2
  370. package/docs/reference/typescript-api/worker/vendure-worker.mdx +2 -2
  371. package/package.json +6 -3
@@ -34,7 +34,7 @@ The port on which the dev server is listening. Overrides the value set by `Admin
34
34
  Specifies the url route to the Admin UI app.
35
35
  ### compile
36
36
 
37
- <MemberInfo kind="property" type={``() => Promise<void>``} />
37
+ <MemberInfo kind="property" type={`() => Promise<void>`} />
38
38
 
39
39
  The function which will be invoked to start the app compilation process.
40
40
 
@@ -23,7 +23,7 @@ class AsyncQueue {
23
23
 
24
24
  ### push
25
25
 
26
- <MemberInfo kind="method" type={`(task: `Task<T>`) => `Promise<T>``} />
26
+ <MemberInfo kind="method" type={`(task: Task<T>) => Promise<T>`} />
27
27
 
28
28
  Pushes a new task onto the queue, upon which the task will either execute immediately or
29
29
  (if the number of running tasks is equal to the concurrency limit) enqueue the task to
@@ -68,7 +68,7 @@ Parameters
68
68
 
69
69
  ### userConfig
70
70
 
71
- <MemberInfo kind="parameter" type={``Partial<`<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>`>``} />
71
+ <MemberInfo kind="parameter" type={`Partial<<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>>`} />
72
72
 
73
73
  ### options
74
74
 
@@ -95,7 +95,7 @@ interface BootstrapOptions {
95
95
  These options get passed directly to the `NestFactory.create()` method.
96
96
  ### ignoreCompatibilityErrorsForPlugins
97
97
 
98
- <MemberInfo kind="property" type={``Array<DynamicModule | Type<any>>``} default={`[]`} since="3.1.0" />
98
+ <MemberInfo kind="property" type={`Array<DynamicModule | Type<any>>`} default={`[]`} since="3.1.0" />
99
99
 
100
100
  By default, if a plugin specifies a compatibility range which does not include the current
101
101
  Vendure version, the bootstrap process will fail. This option allows you to ignore compatibility
@@ -18,7 +18,7 @@ interface InjectableStrategy {
18
18
 
19
19
  ### init
20
20
 
21
- <MemberInfo kind="property" type={`(injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>`) => void | Promise<void>``} />
21
+ <MemberInfo kind="property" type={`(injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>) => void | Promise<void>`} />
22
22
 
23
23
  Defines setup logic to be run during application bootstrap. Receives
24
24
  the <DocsLink href="/reference/typescript-api/common/injector#injector">Injector</DocsLink> as an argument, which allows application providers
@@ -35,7 +35,7 @@ async init(injector: Injector) {
35
35
  ```
36
36
  ### destroy
37
37
 
38
- <MemberInfo kind="property" type={``() => void | Promise<void>``} />
38
+ <MemberInfo kind="property" type={`() => void | Promise<void>`} />
39
39
 
40
40
  Defines teardown logic to be run before application shutdown.
41
41
 
@@ -26,13 +26,13 @@ class Injector {
26
26
 
27
27
  ### get
28
28
 
29
- <MemberInfo kind="method" type={`(typeOrToken: `Type<T> | string | symbol`) => R`} />
29
+ <MemberInfo kind="method" type={`(typeOrToken: Type<T> | string | symbol) => R`} />
30
30
 
31
31
  Retrieve an instance of the given type from the app's dependency injection container.
32
32
  Wraps the Nestjs `ModuleRef.get()` method.
33
33
  ### resolve
34
34
 
35
- <MemberInfo kind="method" type={`(typeOrToken: `Type<T> | string | symbol`, contextId?: ContextId) => `Promise<R>``} />
35
+ <MemberInfo kind="method" type={`(typeOrToken: Type<T> | string | symbol, contextId?: ContextId) => Promise<R>`} />
36
36
 
37
37
  Retrieve an instance of the given scoped provider (transient or request-scoped) from the
38
38
  app's dependency injection container.
@@ -76,7 +76,7 @@ type ConfigArgs = {
76
76
 
77
77
  ### [index]
78
78
 
79
- <MemberInfo kind="property" type={``ConfigArgDef<`<a href='/reference/typescript-api/configurable-operation-def/config-arg-type#configargtype'>ConfigArgType</a>`>``} />
79
+ <MemberInfo kind="property" type={`ConfigArgDef<<a href='/reference/typescript-api/configurable-operation-def/config-arg-type#configargtype'>ConfigArgType</a>>`} />
80
80
 
81
81
 
82
82
 
@@ -39,17 +39,17 @@ type DefaultFormConfigHash = {
39
39
 
40
40
  ### 'boolean-form-input'
41
41
 
42
- <MemberInfo kind="property" type={``Record<string, never>``} />
42
+ <MemberInfo kind="property" type={`Record<string, never>`} />
43
43
 
44
44
 
45
45
  ### 'currency-form-input'
46
46
 
47
- <MemberInfo kind="property" type={``Record<string, never>``} />
47
+ <MemberInfo kind="property" type={`Record<string, never>`} />
48
48
 
49
49
 
50
50
  ### 'customer-group-form-input'
51
51
 
52
- <MemberInfo kind="property" type={``Record<string, never>``} />
52
+ <MemberInfo kind="property" type={`Record<string, never>`} />
53
53
 
54
54
 
55
55
  ### 'date-form-input'
@@ -59,7 +59,7 @@ type DefaultFormConfigHash = {
59
59
 
60
60
  ### 'facet-value-form-input'
61
61
 
62
- <MemberInfo kind="property" type={``Record<string, never>``} />
62
+ <MemberInfo kind="property" type={`Record<string, never>`} />
63
63
 
64
64
 
65
65
  ### 'json-editor-form-input'
@@ -79,27 +79,27 @@ type DefaultFormConfigHash = {
79
79
 
80
80
  ### 'password-form-input'
81
81
 
82
- <MemberInfo kind="property" type={``Record<string, never>``} />
82
+ <MemberInfo kind="property" type={`Record<string, never>`} />
83
83
 
84
84
 
85
85
  ### 'product-selector-form-input'
86
86
 
87
- <MemberInfo kind="property" type={``Record<string, never>``} />
87
+ <MemberInfo kind="property" type={`Record<string, never>`} />
88
88
 
89
89
 
90
90
  ### 'relation-form-input'
91
91
 
92
- <MemberInfo kind="property" type={``Record<string, never>``} />
92
+ <MemberInfo kind="property" type={`Record<string, never>`} />
93
93
 
94
94
 
95
95
  ### 'rich-text-form-input'
96
96
 
97
- <MemberInfo kind="property" type={``Record<string, never>``} />
97
+ <MemberInfo kind="property" type={`Record<string, never>`} />
98
98
 
99
99
 
100
100
  ### 'select-form-input'
101
101
 
102
- <MemberInfo kind="property" type={``{ options?: Array<{ value: string; label?: Array<Omit<LocalizedString, '__typename'>> }>; }``} />
102
+ <MemberInfo kind="property" type={`{ options?: Array<{ value: string; label?: Array<Omit<LocalizedString, '__typename'>> }>; }`} />
103
103
 
104
104
 
105
105
  ### 'text-form-input'
@@ -119,12 +119,12 @@ type DefaultFormConfigHash = {
119
119
 
120
120
  ### 'combination-mode-form-input'
121
121
 
122
- <MemberInfo kind="property" type={``Record<string, never>``} />
122
+ <MemberInfo kind="property" type={`Record<string, never>`} />
123
123
 
124
124
 
125
125
  ### 'struct-form-input'
126
126
 
127
- <MemberInfo kind="property" type={``Record<string, never>``} />
127
+ <MemberInfo kind="property" type={`Record<string, never>`} />
128
128
 
129
129
 
130
130
 
@@ -109,7 +109,7 @@ class ConfigurableOperationDef<T extends ConfigArgs = ConfigArgs> {
109
109
 
110
110
  ### constructor
111
111
 
112
- <MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/configurable-operation-def/configurable-operation-def-options#configurableoperationdefoptions'>ConfigurableOperationDefOptions</a>`<T>`) => ConfigurableOperationDef`} />
112
+ <MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/configurable-operation-def/configurable-operation-def-options#configurableoperationdefoptions'>ConfigurableOperationDefOptions</a><T>) => ConfigurableOperationDef`} />
113
113
 
114
114
 
115
115
  ### init
@@ -130,7 +130,7 @@ Convert a ConfigurableOperationDef into a ConfigurableOperationDefinition object
130
130
  so that it can be sent via the API.
131
131
  ### argsArrayToHash
132
132
 
133
- <MemberInfo kind="method" type={`(args: ConfigArg[]) => `ConfigArgValues<T>``} />
133
+ <MemberInfo kind="method" type={`(args: ConfigArg[]) => ConfigArgValues<T>`} />
134
134
 
135
135
  Coverts an array of ConfigArgs into a hash object:
136
136
 
@@ -90,13 +90,13 @@ The maximum number of items that may be returned by a query which returns a `Pag
90
90
  this is the upper limit of the `take` input option.
91
91
  ### adminApiValidationRules
92
92
 
93
- <MemberInfo kind="property" type={``Array<(context: ValidationContext) => any>``} default={`[]`} />
93
+ <MemberInfo kind="property" type={`Array<(context: ValidationContext) => any>`} default={`[]`} />
94
94
 
95
95
  Custom functions to use as additional validation rules when validating the schema for the admin GraphQL API
96
96
  [ApolloServer validation rules](https://www.apollographql.com/docs/apollo-server/api/apollo-server/#validationrules).
97
97
  ### shopApiValidationRules
98
98
 
99
- <MemberInfo kind="property" type={``Array<(context: ValidationContext) => any>``} default={`[]`} />
99
+ <MemberInfo kind="property" type={`Array<(context: ValidationContext) => any>`} default={`[]`} />
100
100
 
101
101
  Custom functions to use as additional validation rules when validating the schema for the shop GraphQL API
102
102
  [ApolloServer validation rules](https://www.apollographql.com/docs/apollo-server/api/apollo-server/#validationrules).
@@ -58,12 +58,12 @@ class CollectionFilter<T extends ConfigArgs = ConfigArgs> extends ConfigurableOp
58
58
 
59
59
  ### constructor
60
60
 
61
- <MemberInfo kind="method" type={`(config: `CollectionFilterConfig<T>`) => CollectionFilter`} />
61
+ <MemberInfo kind="method" type={`(config: CollectionFilterConfig<T>) => CollectionFilter`} />
62
62
 
63
63
 
64
64
  ### apply
65
65
 
66
- <MemberInfo kind="method" type={`(qb: `SelectQueryBuilder<`<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>`>`, args: ConfigArg[]) => `SelectQueryBuilder<`<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>`>``} />
66
+ <MemberInfo kind="method" type={`(qb: SelectQueryBuilder<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>, args: ConfigArg[]) => SelectQueryBuilder<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>`} />
67
67
 
68
68
 
69
69
 
@@ -109,12 +109,12 @@ class EntityDuplicator<T extends ConfigArgs = ConfigArgs> extends ConfigurableOp
109
109
 
110
110
  ### constructor
111
111
 
112
- <MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/configuration/entity-duplicator#entityduplicatorconfig'>EntityDuplicatorConfig</a>`<T>`) => EntityDuplicator`} />
112
+ <MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/configuration/entity-duplicator#entityduplicatorconfig'>EntityDuplicatorConfig</a><T>) => EntityDuplicator`} />
113
113
 
114
114
 
115
115
  ### duplicate
116
116
 
117
- <MemberInfo kind="method" type={`(input: { ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>; entityName: string; id: <a href='/reference/typescript-api/common/id#id'>ID</a>; args: ConfigArg[]; }) => `Promise<`<a href='/reference/typescript-api/entities/vendure-entity#vendureentity'>VendureEntity</a>`>``} />
117
+ <MemberInfo kind="method" type={`(input: { ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>; entityName: string; id: <a href='/reference/typescript-api/common/id#id'>ID</a>; args: ConfigArg[]; }) => Promise<<a href='/reference/typescript-api/entities/vendure-entity#vendureentity'>VendureEntity</a>>`} />
118
118
 
119
119
 
120
120
 
@@ -151,7 +151,7 @@ interface EntityDuplicatorConfig<T extends ConfigArgs> extends ConfigurableOpera
151
151
 
152
152
  ### requiresPermission
153
153
 
154
- <MemberInfo kind="property" type={``Array<`<a href='/reference/typescript-api/common/permission#permission'>Permission</a>` | string> | `<a href='/reference/typescript-api/common/permission#permission'>Permission</a> | string`} />
154
+ <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/common/permission#permission'>Permission</a> | string> | <a href='/reference/typescript-api/common/permission#permission'>Permission</a> | string`} />
155
155
 
156
156
  The permissions required in order to execute this duplicator. If an array is passed,
157
157
  then the administrator must have at least one of the permissions in the array.
@@ -162,7 +162,7 @@ then the administrator must have at least one of the permissions in the array.
162
162
  The entities for which this duplicator is able to duplicate.
163
163
  ### duplicate
164
164
 
165
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/configuration/entity-duplicator#duplicateentityfn'>DuplicateEntityFn</a>`<T>``} />
165
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/configuration/entity-duplicator#duplicateentityfn'>DuplicateEntityFn</a><T>`} />
166
166
 
167
167
  The function which performs the duplication.
168
168
 
@@ -84,7 +84,7 @@ Defines how the primary key will be stored in the database - either
84
84
  string ID.
85
85
  ### encodeId
86
86
 
87
- <MemberInfo kind="property" type={``(primaryKey: PrimaryKeyType<T>) => string``} />
87
+ <MemberInfo kind="property" type={`(primaryKey: PrimaryKeyType<T>) => string`} />
88
88
 
89
89
  Allows the raw ID from the database to be transformed in some way before exposing
90
90
  it in the GraphQL API.
@@ -95,7 +95,7 @@ case, you can use the encode/decode methods to obfuscate the ID with some kind o
95
95
  encoding scheme, such as base64 (or something more sophisticated).
96
96
  ### decodeId
97
97
 
98
- <MemberInfo kind="property" type={``(id: string) => PrimaryKeyType<T>``} />
98
+ <MemberInfo kind="property" type={`(id: string) => PrimaryKeyType<T>`} />
99
99
 
100
100
  Reverses the transformation performed by the `encodeId` method in order to get
101
101
  back to the raw ID value.
@@ -23,7 +23,7 @@ interface EntityOptions {
23
23
 
24
24
  ### entityIdStrategy
25
25
 
26
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/configuration/entity-id-strategy#entityidstrategy'>EntityIdStrategy</a>`<any>``} default={`<a href='/reference/typescript-api/configuration/entity-id-strategy#autoincrementidstrategy'>AutoIncrementIdStrategy</a>`} since="1.3.0" />
26
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/configuration/entity-id-strategy#entityidstrategy'>EntityIdStrategy</a><any>`} default={`<a href='/reference/typescript-api/configuration/entity-id-strategy#autoincrementidstrategy'>AutoIncrementIdStrategy</a>`} since="1.3.0" />
27
27
 
28
28
  Defines the strategy used for both storing the primary keys of entities
29
29
  in the database, and the encoding & decoding of those ids when exposing
@@ -38,7 +38,7 @@ a fresh database.
38
38
  :::
39
39
  ### entityDuplicators
40
40
 
41
- <MemberInfo kind="property" type={``Array<`<a href='/reference/typescript-api/configuration/entity-duplicator#entityduplicator'>EntityDuplicator</a>`<any>>``} default={`defaultEntityDuplicators`} since="2.2.0" />
41
+ <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/configuration/entity-duplicator#entityduplicator'>EntityDuplicator</a><any>>`} default={`defaultEntityDuplicators`} since="2.2.0" />
42
42
 
43
43
  An array of <DocsLink href="/reference/typescript-api/configuration/entity-duplicator#entityduplicator">EntityDuplicator</DocsLink> instances which are used to duplicate entities
44
44
  when using the `duplicateEntity` mutation.
@@ -29,7 +29,7 @@ interface ProductVariantPriceSelectionStrategy extends InjectableStrategy {
29
29
 
30
30
  ### selectPrice
31
31
 
32
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, prices: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>[]) => <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>` | undefined | Promise<`<a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>` | undefined>``} />
32
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, prices: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>[]) => <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a> | undefined | Promise<<a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a> | undefined>`} />
33
33
 
34
34
 
35
35
 
@@ -54,7 +54,7 @@ interface ProductVariantPriceUpdateStrategy extends InjectableStrategy {
54
54
 
55
55
  ### onPriceCreated
56
56
 
57
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, createdPrice: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>, prices: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>[]) => `UpdatedProductVariantPrice[] | Promise<UpdatedProductVariantPrice[]>``} />
57
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, createdPrice: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>, prices: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>[]) => UpdatedProductVariantPrice[] | Promise<UpdatedProductVariantPrice[]>`} />
58
58
 
59
59
  This method is called when a ProductVariantPrice is created. It receives the created
60
60
  ProductVariantPrice and the array of all prices associated with the ProductVariant.
@@ -63,7 +63,7 @@ It should return an array of UpdatedProductVariantPrice objects which will be us
63
63
  the prices of the specific ProductVariantPrices.
64
64
  ### onPriceUpdated
65
65
 
66
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, updatedPrice: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>, prices: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>[]) => `UpdatedProductVariantPrice[] | Promise<UpdatedProductVariantPrice[]>``} />
66
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, updatedPrice: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>, prices: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>[]) => UpdatedProductVariantPrice[] | Promise<UpdatedProductVariantPrice[]>`} />
67
67
 
68
68
  This method is called when a ProductVariantPrice is updated. It receives the updated
69
69
  ProductVariantPrice and the array of all prices associated with the ProductVariant.
@@ -72,7 +72,7 @@ It should return an array of UpdatedProductVariantPrice objects which will be us
72
72
  the prices of the specific ProductVariantPrices.
73
73
  ### onPriceDeleted
74
74
 
75
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, deletedPrice: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>, prices: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>[]) => `UpdatedProductVariantPrice[] | Promise<UpdatedProductVariantPrice[]>``} />
75
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, deletedPrice: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>, prices: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>[]) => UpdatedProductVariantPrice[] | Promise<UpdatedProductVariantPrice[]>`} />
76
76
 
77
77
  This method is called when a ProductVariantPrice is deleted. It receives the deleted
78
78
  ProductVariantPrice and the array of all prices associated with the ProductVariant.
@@ -33,72 +33,72 @@ interface RuntimeVendureConfig extends Required<VendureConfig> {
33
33
 
34
34
  ### apiOptions
35
35
 
36
- <MemberInfo kind="property" type={``Required<`<a href='/reference/typescript-api/configuration/api-options#apioptions'>ApiOptions</a>`>``} />
36
+ <MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/configuration/api-options#apioptions'>ApiOptions</a>>`} />
37
37
 
38
38
 
39
39
  ### assetOptions
40
40
 
41
- <MemberInfo kind="property" type={``Required<`<a href='/reference/typescript-api/assets/asset-options#assetoptions'>AssetOptions</a>`>``} />
41
+ <MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/assets/asset-options#assetoptions'>AssetOptions</a>>`} />
42
42
 
43
43
 
44
44
  ### authOptions
45
45
 
46
- <MemberInfo kind="property" type={``Required<`<a href='/reference/typescript-api/auth/auth-options#authoptions'>AuthOptions</a>`>``} />
46
+ <MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/auth/auth-options#authoptions'>AuthOptions</a>>`} />
47
47
 
48
48
 
49
49
  ### catalogOptions
50
50
 
51
- <MemberInfo kind="property" type={``Required<`<a href='/reference/typescript-api/products-stock/catalog-options#catalogoptions'>CatalogOptions</a>`>``} />
51
+ <MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/products-stock/catalog-options#catalogoptions'>CatalogOptions</a>>`} />
52
52
 
53
53
 
54
54
  ### customFields
55
55
 
56
- <MemberInfo kind="property" type={``Required<`<a href='/reference/typescript-api/custom-fields/#customfields'>CustomFields</a>`>``} />
56
+ <MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/custom-fields/#customfields'>CustomFields</a>>`} />
57
57
 
58
58
 
59
59
  ### entityOptions
60
60
 
61
- <MemberInfo kind="property" type={``Required<Omit<`<a href='/reference/typescript-api/configuration/entity-options#entityoptions'>EntityOptions</a>`, 'entityIdStrategy'>> &#38; `<a href='/reference/typescript-api/configuration/entity-options#entityoptions'>EntityOptions</a>`} />
61
+ <MemberInfo kind="property" type={`Required<Omit<<a href='/reference/typescript-api/configuration/entity-options#entityoptions'>EntityOptions</a>, 'entityIdStrategy'>> &#38; <a href='/reference/typescript-api/configuration/entity-options#entityoptions'>EntityOptions</a>`} />
62
62
 
63
63
 
64
64
  ### importExportOptions
65
65
 
66
- <MemberInfo kind="property" type={``Required<`<a href='/reference/typescript-api/import-export/import-export-options#importexportoptions'>ImportExportOptions</a>`>``} />
66
+ <MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/import-export/import-export-options#importexportoptions'>ImportExportOptions</a>>`} />
67
67
 
68
68
 
69
69
  ### jobQueueOptions
70
70
 
71
- <MemberInfo kind="property" type={``Required<`<a href='/reference/typescript-api/job-queue/job-queue-options#jobqueueoptions'>JobQueueOptions</a>`>``} />
71
+ <MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/job-queue/job-queue-options#jobqueueoptions'>JobQueueOptions</a>>`} />
72
72
 
73
73
 
74
74
  ### schedulerOptions
75
75
 
76
- <MemberInfo kind="property" type={``Required<`<a href='/reference/typescript-api/scheduled-tasks/scheduler-options#scheduleroptions'>SchedulerOptions</a>`>``} />
76
+ <MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/scheduled-tasks/scheduler-options#scheduleroptions'>SchedulerOptions</a>>`} />
77
77
 
78
78
 
79
79
  ### orderOptions
80
80
 
81
- <MemberInfo kind="property" type={``Required<`<a href='/reference/typescript-api/orders/order-options#orderoptions'>OrderOptions</a>`>``} />
81
+ <MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/orders/order-options#orderoptions'>OrderOptions</a>>`} />
82
82
 
83
83
 
84
84
  ### promotionOptions
85
85
 
86
- <MemberInfo kind="property" type={``Required<`<a href='/reference/typescript-api/promotions/promotion-options#promotionoptions'>PromotionOptions</a>`>``} />
86
+ <MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/promotions/promotion-options#promotionoptions'>PromotionOptions</a>>`} />
87
87
 
88
88
 
89
89
  ### shippingOptions
90
90
 
91
- <MemberInfo kind="property" type={``Required<`<a href='/reference/typescript-api/shipping/shipping-options#shippingoptions'>ShippingOptions</a>`>``} />
91
+ <MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/shipping/shipping-options#shippingoptions'>ShippingOptions</a>>`} />
92
92
 
93
93
 
94
94
  ### taxOptions
95
95
 
96
- <MemberInfo kind="property" type={``Required<`<a href='/reference/typescript-api/tax/tax-options#taxoptions'>TaxOptions</a>`>``} />
96
+ <MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/tax/tax-options#taxoptions'>TaxOptions</a>>`} />
97
97
 
98
98
 
99
99
  ### systemOptions
100
100
 
101
- <MemberInfo kind="property" type={``Required<`<a href='/reference/typescript-api/configuration/system-options#systemoptions'>SystemOptions</a>`>``} />
101
+ <MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/configuration/system-options#systemoptions'>SystemOptions</a>>`} />
102
102
 
103
103
 
104
104
 
@@ -34,7 +34,7 @@ interface SlugStrategy extends InjectableStrategy {
34
34
 
35
35
  ### generate
36
36
 
37
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, params: SlugGenerateParams) => `string | Promise<string>``} />
37
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, params: SlugGenerateParams) => string | Promise<string>`} />
38
38
 
39
39
  Generates a slug from the input string.
40
40
 
@@ -90,7 +90,7 @@ will be randomly generated.
90
90
  The default languageCode of the app.
91
91
  ### entityIdStrategy
92
92
 
93
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/configuration/entity-id-strategy#entityidstrategy'>EntityIdStrategy</a>`<any>``} default={`<a href='/reference/typescript-api/configuration/entity-id-strategy#autoincrementidstrategy'>AutoIncrementIdStrategy</a>`} />
93
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/configuration/entity-id-strategy#entityidstrategy'>EntityIdStrategy</a><any>`} default={`<a href='/reference/typescript-api/configuration/entity-id-strategy#autoincrementidstrategy'>AutoIncrementIdStrategy</a>`} />
94
94
 
95
95
  Defines the strategy used for both storing the primary keys of entities
96
96
  in the database, and the encoding & decoding of those ids when exposing
@@ -118,7 +118,7 @@ Configuration settings governing how orders are handled.
118
118
  Configures available payment processing methods.
119
119
  ### plugins
120
120
 
121
- <MemberInfo kind="property" type={``Array<DynamicModule | Type<any>>``} default={`[]`} />
121
+ <MemberInfo kind="property" type={`Array<DynamicModule | Type<any>>`} default={`[]`} />
122
122
 
123
123
  An array of plugins.
124
124
  ### promotionOptions
@@ -25,7 +25,7 @@ class CalculatedPropertySubscriber implements EntitySubscriberInterface {
25
25
 
26
26
  ### afterInsert
27
27
 
28
- <MemberInfo kind="method" type={`(event: `InsertEvent<any>`) => `Promise<any> | void``} />
28
+ <MemberInfo kind="method" type={`(event: InsertEvent<any>) => Promise<any> | void`} />
29
29
 
30
30
 
31
31
 
@@ -40,7 +40,7 @@ on the entity (e.g. an `Order` entity calculating the `totalQuantity` by adding
40
40
  up the quantities of each `OrderLine`), then those relations should be defined here.
41
41
  ### query
42
42
 
43
- <MemberInfo kind="property" type={``(qb: SelectQueryBuilder<any>) => void``} />
43
+ <MemberInfo kind="property" type={`(qb: SelectQueryBuilder<any>) => void`} />
44
44
 
45
45
 
46
46
  ### expression
@@ -76,7 +76,7 @@ class EntityHydrator {
76
76
 
77
77
  ### hydrate
78
78
 
79
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, target: Entity, options: <a href='/reference/typescript-api/data-access/hydrate-options#hydrateoptions'>HydrateOptions</a>`<Entity>`) => `Promise<Entity>``} since="1.3.0" />
79
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, target: Entity, options: <a href='/reference/typescript-api/data-access/hydrate-options#hydrateoptions'>HydrateOptions</a><Entity>) => Promise<Entity>`} since="1.3.0" />
80
80
 
81
81
  Hydrates (joins) the specified relations to the target entity instance. This method
82
82
  mutates the `target` entity.
@@ -18,7 +18,7 @@ interface HydrateOptions<Entity extends VendureEntity> {
18
18
 
19
19
  ### relations
20
20
 
21
- <MemberInfo kind="property" type={``Array<`<a href='/reference/typescript-api/common/entity-relation-paths#entityrelationpaths'>EntityRelationPaths</a>`<Entity>>``} />
21
+ <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/common/entity-relation-paths#entityrelationpaths'>EntityRelationPaths</a><Entity>>`} />
22
22
 
23
23
  Defines the relations to hydrate, using strings with dot notation to indicate
24
24
  nested joins. If the entity already has a particular relation available, that relation
@@ -90,7 +90,7 @@ class ListQueryBuilder implements OnApplicationBootstrap {
90
90
 
91
91
  ### filterObjectHasProperty
92
92
 
93
- <MemberInfo kind="method" type={`(filterObject: `FP | NullOptionals<FP> | null | undefined`, property: keyof FP) => boolean`} />
93
+ <MemberInfo kind="method" type={`(filterObject: FP | NullOptionals<FP> | null | undefined, property: keyof FP) => boolean`} />
94
94
 
95
95
  Used to determine whether a list query `filter` object contains the
96
96
  given property, either at the top level or nested inside a boolean
@@ -102,7 +102,7 @@ filter object contains that property, which then means we would need
102
102
  to join that relation.
103
103
  ### build
104
104
 
105
- <MemberInfo kind="method" type={`(entity: `Type<T>`, options: `ListQueryOptions<T>` = {}, extendedOptions: <a href='/reference/typescript-api/data-access/list-query-builder#extendedlistqueryoptions'>ExtendedListQueryOptions</a>`<T>` = {}) => `SelectQueryBuilder<T>``} />
105
+ <MemberInfo kind="method" type={`(entity: Type<T>, options: ListQueryOptions<T> = {}, extendedOptions: <a href='/reference/typescript-api/data-access/list-query-builder#extendedlistqueryoptions'>ExtendedListQueryOptions</a><T> = {}) => SelectQueryBuilder<T>`} />
106
106
 
107
107
 
108
108
 
@@ -139,12 +139,12 @@ type ExtendedListQueryOptions<T extends VendureEntity> = {
139
139
 
140
140
  ### where
141
141
 
142
- <MemberInfo kind="property" type={``FindOptionsWhere<T>``} />
142
+ <MemberInfo kind="property" type={`FindOptionsWhere<T>`} />
143
143
 
144
144
 
145
145
  ### orderBy
146
146
 
147
- <MemberInfo kind="property" type={``FindOneOptions<T>['order']``} />
147
+ <MemberInfo kind="property" type={`FindOneOptions<T>['order']`} />
148
148
 
149
149
 
150
150
  ### entityAlias
@@ -51,14 +51,14 @@ performed with this connection will not be performed within any outer
51
51
  transactions.
52
52
  ### getRepository
53
53
 
54
- <MemberInfo kind="method" type={`(target: `ObjectType<Entity> | EntitySchema<Entity> | string`) => `Repository<Entity>``} />
54
+ <MemberInfo kind="method" type={`(target: ObjectType<Entity> | EntitySchema<Entity> | string) => Repository<Entity>`} />
55
55
 
56
56
  Returns a TypeORM repository. Note that when no RequestContext is supplied, the repository will not
57
57
  be aware of any existing transaction. Therefore, calling this method without supplying a RequestContext
58
58
  is discouraged without a deliberate reason.
59
59
  ### getRepository
60
60
 
61
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | undefined, target: `ObjectType<Entity> | EntitySchema<Entity> | string`, options?: { replicationMode?: ReplicationMode; }) => `Repository<Entity>``} />
61
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | undefined, target: ObjectType<Entity> | EntitySchema<Entity> | string, options?: { replicationMode?: ReplicationMode; }) => Repository<Entity>`} />
62
62
 
63
63
  Returns a TypeORM repository which is bound to any existing transactions. It is recommended to _always_ pass
64
64
  the RequestContext argument when possible, otherwise the queries will be executed outside of any
@@ -68,14 +68,14 @@ The `options` parameter allows specifying additional configurations, such as the
68
68
  which determines whether the repository should interact with the master or replica database.
69
69
  ### getRepository
70
70
 
71
- <MemberInfo kind="method" type={`(ctxOrTarget: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>` | ObjectType<Entity> | EntitySchema<Entity> | string | undefined`, maybeTarget?: `ObjectType<Entity> | EntitySchema<Entity> | string`, options?: { replicationMode?: ReplicationMode; }) => `Repository<Entity>``} />
71
+ <MemberInfo kind="method" type={`(ctxOrTarget: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | ObjectType<Entity> | EntitySchema<Entity> | string | undefined, maybeTarget?: ObjectType<Entity> | EntitySchema<Entity> | string, options?: { replicationMode?: ReplicationMode; }) => Repository<Entity>`} />
72
72
 
73
73
  Returns a TypeORM repository. Depending on the parameters passed, it will either be transaction-aware
74
74
  or not. If `RequestContext` is provided, the repository is bound to any ongoing transactions. The
75
75
  `options` parameter allows further customization, such as selecting the replication mode (e.g., 'master').
76
76
  ### withTransaction
77
77
 
78
- <MemberInfo kind="method" type={`(work: (ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>`) => Promise<T>`) => `Promise<T>``} since="1.3.0" />
78
+ <MemberInfo kind="method" type={`(work: (ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<T>) => Promise<T>`} since="1.3.0" />
79
79
 
80
80
  Allows database operations to be wrapped in a transaction, ensuring that in the event of an error being
81
81
  thrown at any point, the entire transaction will be rolled back and no changes will be saved.
@@ -116,12 +116,12 @@ private async transferCredit(outerCtx: RequestContext, fromId: ID, toId: ID, amo
116
116
  ```
117
117
  ### withTransaction
118
118
 
119
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, work: (ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>`) => Promise<T>`) => `Promise<T>``} />
119
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, work: (ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<T>) => Promise<T>`} />
120
120
 
121
121
 
122
122
  ### withTransaction
123
123
 
124
- <MemberInfo kind="method" type={`(ctxOrWork: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | ((ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>`) => Promise<T>)`, maybeWork?: (ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>`) => Promise<T>`) => `Promise<T>``} />
124
+ <MemberInfo kind="method" type={`(ctxOrWork: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | ((ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<T>), maybeWork?: (ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<T>) => Promise<T>`} />
125
125
 
126
126
 
127
127
  ### startTransaction
@@ -147,19 +147,19 @@ and the internal TransactionInterceptor take care of this automatically. Use-cas
147
147
  Transaction decorator in manual mode.
148
148
  ### getEntityOrThrow
149
149
 
150
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entityType: `Type<T>`, id: <a href='/reference/typescript-api/common/id#id'>ID</a>, options: <a href='/reference/typescript-api/data-access/get-entity-or-throw-options#getentityorthrowoptions'>GetEntityOrThrowOptions</a>`<T>` = {}) => `Promise<T>``} />
150
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entityType: Type<T>, id: <a href='/reference/typescript-api/common/id#id'>ID</a>, options: <a href='/reference/typescript-api/data-access/get-entity-or-throw-options#getentityorthrowoptions'>GetEntityOrThrowOptions</a><T> = {}) => Promise<T>`} />
151
151
 
152
152
  Finds an entity of the given type by ID, or throws an `EntityNotFoundError` if none
153
153
  is found.
154
154
  ### findOneInChannel
155
155
 
156
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: `Type<T>`, id: <a href='/reference/typescript-api/common/id#id'>ID</a>, channelId: <a href='/reference/typescript-api/common/id#id'>ID</a>, options: `FindOneOptions<T>` = {}) => `} />
156
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: Type<T>, id: <a href='/reference/typescript-api/common/id#id'>ID</a>, channelId: <a href='/reference/typescript-api/common/id#id'>ID</a>, options: FindOneOptions<T> = {}) => `} />
157
157
 
158
158
  Like the TypeOrm `Repository.findOne()` method, but limits the results to
159
159
  the given Channel.
160
160
  ### findByIdsInChannel
161
161
 
162
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: `Type<T>`, ids: <a href='/reference/typescript-api/common/id#id'>ID</a>[], channelId: <a href='/reference/typescript-api/common/id#id'>ID</a>, options: `FindManyOptions<T>`) => `} />
162
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: Type<T>, ids: <a href='/reference/typescript-api/common/id#id'>ID</a>[], channelId: <a href='/reference/typescript-api/common/id#id'>ID</a>, options: FindManyOptions<T>) => `} />
163
163
 
164
164
  Like the TypeOrm `Repository.findByIds()` method, but limits the results to
165
165
  the given Channel.