@vendure/docs 0.0.0-202601211551 → 0.0.0-202601211609

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 (358) 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-hooks/use-injector.mdx +1 -1
  44. package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx +1 -1
  45. package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx +1 -1
  46. package/docs/reference/admin-ui-api/react-hooks/use-query.mdx +1 -1
  47. package/docs/reference/admin-ui-api/services/data-service.mdx +9 -9
  48. package/docs/reference/admin-ui-api/services/modal-service.mdx +5 -5
  49. package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx +1 -1
  50. package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +1 -1
  51. package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
  52. package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +1 -1
  53. package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +2 -2
  54. package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
  55. package/docs/reference/core-plugins/asset-server-plugin/index.mdx +1 -1
  56. package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +8 -8
  57. package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +1 -1
  58. package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +2 -2
  59. package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +1 -1
  60. package/docs/reference/core-plugins/dashboard-plugin/index.mdx +1 -1
  61. package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +8 -8
  62. package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
  63. package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +1 -1
  64. package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +6 -6
  65. package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
  66. package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
  67. package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +2 -2
  68. package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +1 -1
  69. package/docs/reference/core-plugins/email-plugin/email-sender.mdx +1 -1
  70. package/docs/reference/core-plugins/email-plugin/index.mdx +1 -1
  71. package/docs/reference/core-plugins/email-plugin/template-loader.mdx +4 -4
  72. package/docs/reference/core-plugins/email-plugin/transport-options.mdx +1 -1
  73. package/docs/reference/core-plugins/graphiql-plugin/index.mdx +2 -2
  74. package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -1
  75. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +9 -9
  76. package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +5 -5
  77. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +3 -3
  78. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx +1 -1
  79. package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx +2 -2
  80. package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx +1 -1
  81. package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +5 -5
  82. package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +3 -3
  83. package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx +1 -1
  84. package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx +1 -1
  85. package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +2 -2
  86. package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -1
  87. package/docs/reference/dashboard/components/asset-gallery.mdx +3 -3
  88. package/docs/reference/dashboard/components/asset-picker-dialog.mdx +2 -2
  89. package/docs/reference/dashboard/components/channel-chip.mdx +1 -1
  90. package/docs/reference/dashboard/components/detail-page-button.mdx +1 -1
  91. package/docs/reference/dashboard/components/facet-value-selector.mdx +1 -1
  92. package/docs/reference/dashboard/components/permission-guard.mdx +1 -1
  93. package/docs/reference/dashboard/components/vendure-image.mdx +1 -1
  94. package/docs/reference/dashboard/detail-views/detail-page.mdx +2 -2
  95. package/docs/reference/dashboard/detail-views/use-detail-page.mdx +10 -10
  96. package/docs/reference/dashboard/detail-views/use-generated-form.mdx +2 -2
  97. package/docs/reference/dashboard/extensions-api/action-bar.mdx +1 -1
  98. package/docs/reference/dashboard/extensions-api/alerts.mdx +6 -6
  99. package/docs/reference/dashboard/extensions-api/data-tables.mdx +1 -1
  100. package/docs/reference/dashboard/extensions-api/detail-forms.mdx +1 -1
  101. package/docs/reference/dashboard/extensions-api/history-entries.mdx +2 -2
  102. package/docs/reference/dashboard/extensions-api/page-blocks.mdx +2 -2
  103. package/docs/reference/dashboard/extensions-api/routes.mdx +4 -4
  104. package/docs/reference/dashboard/extensions-api/widgets.mdx +1 -1
  105. package/docs/reference/dashboard/form-components/affixed-input.mdx +1 -1
  106. package/docs/reference/dashboard/form-components/boolean-input.mdx +1 -1
  107. package/docs/reference/dashboard/form-components/checkbox-input.mdx +1 -1
  108. package/docs/reference/dashboard/form-components/date-time-input.mdx +1 -1
  109. package/docs/reference/dashboard/form-components/money-input.mdx +1 -1
  110. package/docs/reference/dashboard/form-components/number-input.mdx +1 -1
  111. package/docs/reference/dashboard/form-components/password-input.mdx +1 -1
  112. package/docs/reference/dashboard/form-components/rich-text-input.mdx +1 -1
  113. package/docs/reference/dashboard/form-components/textarea-input.mdx +1 -1
  114. package/docs/reference/dashboard/hooks/use-alerts.mdx +1 -1
  115. package/docs/reference/dashboard/hooks/use-auth.mdx +5 -5
  116. package/docs/reference/dashboard/hooks/use-channel.mdx +2 -2
  117. package/docs/reference/dashboard/hooks/use-drag-and-drop.mdx +1 -1
  118. package/docs/reference/dashboard/list-views/bulk-actions.mdx +3 -3
  119. package/docs/reference/dashboard/list-views/data-table.mdx +10 -10
  120. package/docs/reference/dashboard/list-views/list-page.mdx +13 -13
  121. package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +17 -17
  122. package/docs/reference/dashboard/page-layout/index.mdx +1 -1
  123. package/docs/reference/dashboard/page-layout/page-action-bar.mdx +3 -3
  124. package/docs/reference/dashboard/page-layout/page-block.mdx +3 -3
  125. package/docs/reference/dashboard/page-layout/page-title.mdx +1 -1
  126. package/docs/reference/dashboard/page-layout/page.mdx +2 -2
  127. package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
  128. package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +6 -6
  129. package/docs/reference/typescript-api/auth/auth-options.mdx +1 -1
  130. package/docs/reference/typescript-api/auth/authentication-strategy.mdx +2 -2
  131. package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +2 -2
  132. package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +4 -4
  133. package/docs/reference/typescript-api/auth/external-authentication-service.mdx +5 -5
  134. package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +2 -2
  135. package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +2 -2
  136. package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +1 -1
  137. package/docs/reference/typescript-api/auth/permission-definition.mdx +2 -2
  138. package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +4 -4
  139. package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +2 -2
  140. package/docs/reference/typescript-api/cache/cache-config.mdx +1 -1
  141. package/docs/reference/typescript-api/cache/cache-service.mdx +4 -4
  142. package/docs/reference/typescript-api/cache/cache-strategy.mdx +4 -4
  143. package/docs/reference/typescript-api/cache/index.mdx +3 -3
  144. package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +4 -4
  145. package/docs/reference/typescript-api/cache/request-context-cache-service.mdx +2 -2
  146. package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +5 -5
  147. package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +1 -1
  148. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx +1 -1
  149. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx +1 -1
  150. package/docs/reference/typescript-api/common/async-queue.mdx +1 -1
  151. package/docs/reference/typescript-api/common/bootstrap.mdx +2 -2
  152. package/docs/reference/typescript-api/common/injectable-strategy.mdx +2 -2
  153. package/docs/reference/typescript-api/common/injector.mdx +2 -2
  154. package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +1 -1
  155. package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx +11 -11
  156. package/docs/reference/typescript-api/configurable-operation-def/index.mdx +1 -1
  157. package/docs/reference/typescript-api/configuration/api-options.mdx +2 -2
  158. package/docs/reference/typescript-api/configuration/collection-filter.mdx +2 -2
  159. package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +2 -2
  160. package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +2 -2
  161. package/docs/reference/typescript-api/configuration/entity-options.mdx +1 -1
  162. package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +1 -1
  163. package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +3 -3
  164. package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +14 -14
  165. package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
  166. package/docs/reference/typescript-api/configuration/vendure-config.mdx +1 -1
  167. package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +1 -1
  168. package/docs/reference/typescript-api/data-access/calculated.mdx +1 -1
  169. package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
  170. package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
  171. package/docs/reference/typescript-api/data-access/list-query-builder.mdx +4 -4
  172. package/docs/reference/typescript-api/data-access/transactional-connection.mdx +9 -9
  173. package/docs/reference/typescript-api/default-search-plugin/index.mdx +1 -1
  174. package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +4 -4
  175. package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +4 -4
  176. package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +4 -4
  177. package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +4 -4
  178. package/docs/reference/typescript-api/entities/address.mdx +1 -1
  179. package/docs/reference/typescript-api/entities/administrator.mdx +1 -1
  180. package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
  181. package/docs/reference/typescript-api/entities/asset.mdx +1 -1
  182. package/docs/reference/typescript-api/entities/authenticated-session.mdx +1 -1
  183. package/docs/reference/typescript-api/entities/authentication-method.mdx +2 -2
  184. package/docs/reference/typescript-api/entities/channel.mdx +1 -1
  185. package/docs/reference/typescript-api/entities/collection.mdx +2 -2
  186. package/docs/reference/typescript-api/entities/country.mdx +1 -1
  187. package/docs/reference/typescript-api/entities/customer-group.mdx +1 -1
  188. package/docs/reference/typescript-api/entities/customer-history-entry.mdx +1 -1
  189. package/docs/reference/typescript-api/entities/customer.mdx +1 -1
  190. package/docs/reference/typescript-api/entities/facet-value.mdx +2 -2
  191. package/docs/reference/typescript-api/entities/facet.mdx +2 -2
  192. package/docs/reference/typescript-api/entities/fulfillment.mdx +1 -1
  193. package/docs/reference/typescript-api/entities/global-settings.mdx +1 -1
  194. package/docs/reference/typescript-api/entities/interfaces.mdx +1 -1
  195. package/docs/reference/typescript-api/entities/order-history-entry.mdx +1 -1
  196. package/docs/reference/typescript-api/entities/order-line-reference.mdx +3 -3
  197. package/docs/reference/typescript-api/entities/order-line.mdx +1 -1
  198. package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
  199. package/docs/reference/typescript-api/entities/order.mdx +1 -1
  200. package/docs/reference/typescript-api/entities/orderable-asset.mdx +1 -1
  201. package/docs/reference/typescript-api/entities/payment-method.mdx +2 -2
  202. package/docs/reference/typescript-api/entities/payment.mdx +1 -1
  203. package/docs/reference/typescript-api/entities/product-option-group.mdx +2 -2
  204. package/docs/reference/typescript-api/entities/product-option.mdx +2 -2
  205. package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -1
  206. package/docs/reference/typescript-api/entities/product-variant.mdx +2 -2
  207. package/docs/reference/typescript-api/entities/product.mdx +2 -2
  208. package/docs/reference/typescript-api/entities/promotion.mdx +4 -4
  209. package/docs/reference/typescript-api/entities/province.mdx +1 -1
  210. package/docs/reference/typescript-api/entities/refund.mdx +1 -1
  211. package/docs/reference/typescript-api/entities/region.mdx +1 -1
  212. package/docs/reference/typescript-api/entities/role.mdx +1 -1
  213. package/docs/reference/typescript-api/entities/seller.mdx +1 -1
  214. package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
  215. package/docs/reference/typescript-api/entities/shipping-line.mdx +1 -1
  216. package/docs/reference/typescript-api/entities/shipping-method.mdx +4 -4
  217. package/docs/reference/typescript-api/entities/stock-level.mdx +1 -1
  218. package/docs/reference/typescript-api/entities/stock-location.mdx +1 -1
  219. package/docs/reference/typescript-api/entities/stock-movement.mdx +5 -5
  220. package/docs/reference/typescript-api/entities/surcharge.mdx +1 -1
  221. package/docs/reference/typescript-api/entities/tag.mdx +1 -1
  222. package/docs/reference/typescript-api/entities/tax-category.mdx +1 -1
  223. package/docs/reference/typescript-api/entities/tax-rate.mdx +1 -1
  224. package/docs/reference/typescript-api/entities/user.mdx +1 -1
  225. package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -1
  226. package/docs/reference/typescript-api/entities/zone.mdx +1 -1
  227. package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +2 -2
  228. package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx +2 -2
  229. package/docs/reference/typescript-api/events/event-bus.mdx +3 -3
  230. package/docs/reference/typescript-api/events/event-types.mdx +1 -1
  231. package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +1 -1
  232. package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +4 -4
  233. package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +1 -1
  234. package/docs/reference/typescript-api/import-export/asset-importer.mdx +1 -1
  235. package/docs/reference/typescript-api/import-export/fast-importer-service.mdx +4 -4
  236. package/docs/reference/typescript-api/import-export/import-parser.mdx +5 -5
  237. package/docs/reference/typescript-api/import-export/importer.mdx +3 -3
  238. package/docs/reference/typescript-api/import-export/initial-data.mdx +3 -3
  239. package/docs/reference/typescript-api/import-export/populate.mdx +1 -1
  240. package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -5
  241. package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +3 -3
  242. package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +8 -8
  243. package/docs/reference/typescript-api/job-queue/index.mdx +1 -1
  244. package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +5 -5
  245. package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +3 -3
  246. package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
  247. package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +4 -4
  248. package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +3 -3
  249. package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +8 -8
  250. package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +6 -6
  251. package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +1 -1
  252. package/docs/reference/typescript-api/job-queue/types.mdx +1 -1
  253. package/docs/reference/typescript-api/migration/generate-migration.mdx +1 -1
  254. package/docs/reference/typescript-api/migration/revert-last-migration.mdx +1 -1
  255. package/docs/reference/typescript-api/migration/run-migrations.mdx +1 -1
  256. package/docs/reference/typescript-api/orders/active-order-service.mdx +6 -6
  257. package/docs/reference/typescript-api/orders/active-order-strategy.mdx +3 -3
  258. package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +1 -1
  259. package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +1 -1
  260. package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +1 -1
  261. package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -1
  262. package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
  263. package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +1 -1
  264. package/docs/reference/typescript-api/orders/order-code-strategy.mdx +1 -1
  265. package/docs/reference/typescript-api/orders/order-interceptor.mdx +3 -3
  266. package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +1 -1
  267. package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
  268. package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
  269. package/docs/reference/typescript-api/orders/order-process.mdx +4 -4
  270. package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +3 -3
  271. package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
  272. package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +1 -1
  273. package/docs/reference/typescript-api/payment/payment-method-types.mdx +3 -3
  274. package/docs/reference/typescript-api/payment/payment-options.mdx +3 -3
  275. package/docs/reference/typescript-api/payment/payment-process.mdx +4 -4
  276. package/docs/reference/typescript-api/payment/refund-process.mdx +4 -4
  277. package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +4 -4
  278. package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
  279. package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
  280. package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +1 -1
  281. package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -2
  282. package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +1 -1
  283. package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
  284. package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +5 -5
  285. package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +1 -1
  286. package/docs/reference/typescript-api/promotions/promotion-action.mdx +1 -1
  287. package/docs/reference/typescript-api/promotions/promotion-condition.mdx +1 -1
  288. package/docs/reference/typescript-api/promotions/promotion-options.mdx +2 -2
  289. package/docs/reference/typescript-api/request/request-context-service.mdx +2 -2
  290. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +4 -4
  291. package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +3 -3
  292. package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +3 -3
  293. package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +5 -5
  294. package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +1 -1
  295. package/docs/reference/typescript-api/service-helpers/order-calculator.mdx +1 -1
  296. package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +3 -3
  297. package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -1
  298. package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +2 -2
  299. package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +2 -2
  300. package/docs/reference/typescript-api/service-helpers/translator-service.mdx +1 -1
  301. package/docs/reference/typescript-api/services/administrator-service.mdx +6 -6
  302. package/docs/reference/typescript-api/services/asset-service.mdx +13 -13
  303. package/docs/reference/typescript-api/services/auth-service.mdx +4 -4
  304. package/docs/reference/typescript-api/services/channel-service.mdx +12 -12
  305. package/docs/reference/typescript-api/services/collection-service.mdx +20 -20
  306. package/docs/reference/typescript-api/services/country-service.mdx +7 -7
  307. package/docs/reference/typescript-api/services/customer-group-service.mdx +8 -8
  308. package/docs/reference/typescript-api/services/customer-service.mdx +24 -24
  309. package/docs/reference/typescript-api/services/entity-slug-service.mdx +1 -1
  310. package/docs/reference/typescript-api/services/facet-service.mdx +11 -11
  311. package/docs/reference/typescript-api/services/facet-value-service.mdx +12 -12
  312. package/docs/reference/typescript-api/services/fulfillment-service.mdx +4 -4
  313. package/docs/reference/typescript-api/services/global-settings-service.mdx +2 -2
  314. package/docs/reference/typescript-api/services/history-service.mdx +8 -8
  315. package/docs/reference/typescript-api/services/order-service.mdx +52 -52
  316. package/docs/reference/typescript-api/services/order-testing-service.mdx +2 -2
  317. package/docs/reference/typescript-api/services/payment-method-service.mdx +10 -10
  318. package/docs/reference/typescript-api/services/payment-service.mdx +7 -7
  319. package/docs/reference/typescript-api/services/product-option-group-service.mdx +5 -5
  320. package/docs/reference/typescript-api/services/product-option-service.mdx +5 -5
  321. package/docs/reference/typescript-api/services/product-service.mdx +13 -13
  322. package/docs/reference/typescript-api/services/product-variant-service.mdx +22 -22
  323. package/docs/reference/typescript-api/services/promotion-service.mdx +9 -9
  324. package/docs/reference/typescript-api/services/province-service.mdx +5 -5
  325. package/docs/reference/typescript-api/services/role-service.mdx +11 -11
  326. package/docs/reference/typescript-api/services/search-service.mdx +2 -2
  327. package/docs/reference/typescript-api/services/seller-service.mdx +3 -3
  328. package/docs/reference/typescript-api/services/session-service.mdx +8 -8
  329. package/docs/reference/typescript-api/services/settings-store-service.mdx +15 -15
  330. package/docs/reference/typescript-api/services/shipping-method-service.mdx +8 -8
  331. package/docs/reference/typescript-api/services/slug-service.mdx +1 -1
  332. package/docs/reference/typescript-api/services/stock-level-service.mdx +3 -3
  333. package/docs/reference/typescript-api/services/stock-location-service.mdx +7 -7
  334. package/docs/reference/typescript-api/services/stock-movement-service.mdx +7 -7
  335. package/docs/reference/typescript-api/services/tag-service.mdx +5 -5
  336. package/docs/reference/typescript-api/services/tax-category-service.mdx +5 -5
  337. package/docs/reference/typescript-api/services/tax-rate-service.mdx +6 -6
  338. package/docs/reference/typescript-api/services/user-service.mdx +12 -12
  339. package/docs/reference/typescript-api/services/zone-service.mdx +8 -8
  340. package/docs/reference/typescript-api/settings-store/settings-store-field-config.mdx +2 -2
  341. package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +1 -1
  342. package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +2 -2
  343. package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +1 -1
  344. package/docs/reference/typescript-api/shipping/shipping-options.mdx +5 -5
  345. package/docs/reference/typescript-api/state-machine/fsm.mdx +1 -1
  346. package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +1 -1
  347. package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +1 -1
  348. package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +2 -2
  349. package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -1
  350. package/docs/reference/typescript-api/testing/create-test-environment.mdx +1 -1
  351. package/docs/reference/typescript-api/testing/error-result-guard.mdx +1 -1
  352. package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx +5 -5
  353. package/docs/reference/typescript-api/testing/test-db-initializer.mdx +3 -3
  354. package/docs/reference/typescript-api/testing/test-server.mdx +2 -2
  355. package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
  356. package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -2
  357. package/docs/reference/typescript-api/worker/vendure-worker.mdx +2 -2
  358. package/package.json +1 -1
@@ -24,7 +24,7 @@ class ModalService {
24
24
 
25
25
  ### fromComponent
26
26
 
27
- <MemberInfo kind="method" type={`(component: Type<T> &#38; Type<<a href='/reference/admin-ui-api/services/modal-service#dialog'>Dialog</a>`<R>`>, options?: <a href='/reference/admin-ui-api/services/modal-service#modaloptions'>ModalOptions</a>`<T>`) => Observable<R | undefined>`} />
27
+ <MemberInfo kind="method" type={`(component: `Type<T> &#38; Type<`<a href='/reference/admin-ui-api/services/modal-service#dialog'>Dialog</a>`<R>>`, options?: <a href='/reference/admin-ui-api/services/modal-service#modaloptions'>ModalOptions</a>`<T>`) => `Observable<R | undefined>``} />
28
28
 
29
29
  Create a modal from a component. The component must implement the <DocsLink href="/reference/admin-ui-api/services/modal-service#dialog">Dialog</DocsLink> interface.
30
30
  Additionally, the component should include templates for the title and the buttons to be
@@ -68,7 +68,7 @@ class MyDialog implements Dialog {
68
68
  ```
69
69
  ### dialog
70
70
 
71
- <MemberInfo kind="method" type={`(config: <a href='/reference/admin-ui-api/services/modal-service#dialogconfig'>DialogConfig</a>`<T>`) => Observable<T | undefined>`} />
71
+ <MemberInfo kind="method" type={`(config: <a href='/reference/admin-ui-api/services/modal-service#dialogconfig'>DialogConfig</a>`<T>`) => `Observable<T | undefined>``} />
72
72
 
73
73
  Displays a modal dialog with the provided title, body and buttons.
74
74
 
@@ -89,7 +89,7 @@ interface Dialog<R = any> {
89
89
 
90
90
  ### resolveWith
91
91
 
92
- <MemberInfo kind="property" type={`(result?: R) => void`} />
92
+ <MemberInfo kind="property" type={``(result?: R) => void``} />
93
93
 
94
94
  Function to be invoked in order to close the dialog when the action is complete.
95
95
  The Observable returned from the .fromComponent() method will emit the value passed
@@ -130,7 +130,7 @@ interface DialogConfig<T> {
130
130
 
131
131
  ### buttons
132
132
 
133
- <MemberInfo kind="property" type={`Array<DialogButtonConfig<T>>`} />
133
+ <MemberInfo kind="property" type={``Array<DialogButtonConfig<T>>``} />
134
134
 
135
135
 
136
136
  ### size
@@ -174,7 +174,7 @@ When true, the "x" icon is shown
174
174
  and clicking it or the mask will close the dialog
175
175
  ### locals
176
176
 
177
- <MemberInfo kind="property" type={`Partial<T>`} />
177
+ <MemberInfo kind="property" type={``Partial<T>``} />
178
178
 
179
179
  Values to be passed directly to the component being instantiated inside the dialog.
180
180
 
@@ -50,7 +50,7 @@ The name of the tab to display in the UI.
50
50
  The priority of the tab. Tabs with a lower priority will be displayed first.
51
51
  ### component
52
52
 
53
- <MemberInfo kind="property" type={`Type<any> | ReturnType<typeof <a href='/reference/admin-ui-api/list-detail-views/detail-component-with-resolver#detailcomponentwithresolver'>detailComponentWithResolver</a>>`} />
53
+ <MemberInfo kind="property" type={``Type<any> | ReturnType<typeof `<a href='/reference/admin-ui-api/list-detail-views/detail-component-with-resolver#detailcomponentwithresolver'>detailComponentWithResolver</a>`>``} />
54
54
 
55
55
  The component to render at the route of the tab.
56
56
  ### routeConfig
@@ -45,7 +45,7 @@ will be copied into the Admin UI app, including all TypeScript source files, htm
45
45
  scss style sheets etc.
46
46
  ### ngModules
47
47
 
48
- <MemberInfo kind="property" type={`Array<<a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#adminuiextensionsharedmodule'>AdminUiExtensionSharedModule</a> | <a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#adminuiextensionlazymodule'>AdminUiExtensionLazyModule</a>>`} />
48
+ <MemberInfo kind="property" type={``Array<`<a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#adminuiextensionsharedmodule'>AdminUiExtensionSharedModule</a> | <a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#adminuiextensionlazymodule'>AdminUiExtensionLazyModule</a>`>``} />
49
49
 
50
50
  One or more Angular modules which extend the default Admin UI.
51
51
  ### providers
@@ -48,7 +48,7 @@ Admin UI. This option can be used to override this default build with a differen
48
48
  version, e.g. one pre-compiled with one or more ui extensions.
49
49
  ### adminUiConfig
50
50
 
51
- <MemberInfo kind="property" type={`Partial<<a href='/reference/typescript-api/common/admin-ui/admin-ui-config#adminuiconfig'>AdminUiConfig</a>>`} />
51
+ <MemberInfo kind="property" type={``Partial<`<a href='/reference/typescript-api/common/admin-ui/admin-ui-config#adminuiconfig'>AdminUiConfig</a>`>``} />
52
52
 
53
53
  Allows the contents of the `vendure-ui-config.json` file to be set, e.g.
54
54
  for specifying the Vendure GraphQL API host, available UI languages, etc.
@@ -76,7 +76,7 @@ class AdminUiPlugin implements NestModule {
76
76
 
77
77
  ### init
78
78
 
79
- <MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options#adminuipluginoptions'>AdminUiPluginOptions</a>) => Type<<a href='/reference/core-plugins/admin-ui-plugin/#adminuiplugin'>AdminUiPlugin</a>>`} />
79
+ <MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options#adminuipluginoptions'>AdminUiPluginOptions</a>) => `Type<`<a href='/reference/core-plugins/admin-ui-plugin/#adminuiplugin'>AdminUiPlugin</a>`>``} />
80
80
 
81
81
  Set the plugin options
82
82
  ### configure
@@ -38,7 +38,7 @@ The route to the asset server.
38
38
  The local directory to which assets will be uploaded when using the <DocsLink href="/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy">LocalAssetStorageStrategy</DocsLink>.
39
39
  ### assetUrlPrefix
40
40
 
41
- <MemberInfo kind="property" type={`string | ((ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, identifier: string) => string)`} />
41
+ <MemberInfo kind="property" type={`string | ((ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>`, identifier: string) => string)``} />
42
42
 
43
43
  The complete URL prefix of the asset files. For example, "https://demo.vendure.io/assets/". A
44
44
  function can also be provided to handle more complex cases, such as serving multiple domains
@@ -86,7 +86,7 @@ Defines how previews are generated for a given Asset binary. By default, this us
86
86
  the <DocsLink href="/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy#sharpassetpreviewstrategy">SharpAssetPreviewStrategy</DocsLink>
87
87
  ### storageStrategyFactory
88
88
 
89
- <MemberInfo kind="property" type={`( options: <a href='/reference/core-plugins/asset-server-plugin/asset-server-options#assetserveroptions'>AssetServerOptions</a>, ) => <a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a> | Promise<<a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a>>`} default={`() => <a href='/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy'>LocalAssetStorageStrategy</a>`} />
89
+ <MemberInfo kind="property" type={`( options: <a href='/reference/core-plugins/asset-server-plugin/asset-server-options#assetserveroptions'>AssetServerOptions</a>`, ) => `<a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a>` | Promise<`<a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a>`>``} default={``() => `<a href='/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy'>LocalAssetStorageStrategy</a>`} />
90
90
 
91
91
  A function which can be used to configure an <DocsLink href="/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy">AssetStorageStrategy</DocsLink>. This is useful e.g. if you wish to store your assets
92
92
  using a cloud storage provider. By default, the <DocsLink href="/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy">LocalAssetStorageStrategy</DocsLink> is used.
@@ -29,7 +29,7 @@ interface ImageTransformStrategy extends InjectableStrategy {
29
29
 
30
30
  ### getImageTransformParameters
31
31
 
32
- <MemberInfo kind="method" type={`(args: <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#getimagetransformparametersargs'>GetImageTransformParametersArgs</a>) => Promise<<a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>> | <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>`} />
32
+ <MemberInfo kind="method" type={`(args: <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#getimagetransformparametersargs'>GetImageTransformParametersArgs</a>) => `Promise<`<a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>`> | `<a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>`} />
33
33
 
34
34
  Given the input parameters, return the parameters which should be used to transform the image.
35
35
 
@@ -166,7 +166,7 @@ class AssetServerPlugin implements NestModule, OnApplicationBootstrap, OnApplica
166
166
 
167
167
  ### init
168
168
 
169
- <MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/asset-server-plugin/asset-server-options#assetserveroptions'>AssetServerOptions</a>) => Type<<a href='/reference/core-plugins/asset-server-plugin/#assetserverplugin'>AssetServerPlugin</a>>`} />
169
+ <MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/asset-server-plugin/asset-server-options#assetserveroptions'>AssetServerOptions</a>) => `Type<`<a href='/reference/core-plugins/asset-server-plugin/#assetserverplugin'>AssetServerPlugin</a>`>``} />
170
170
 
171
171
  Set the plugin options.
172
172
  ### constructor
@@ -26,42 +26,42 @@ class LocalAssetStorageStrategy implements AssetStorageStrategy {
26
26
 
27
27
  ### toAbsoluteUrl
28
28
 
29
- <MemberInfo kind="property" type={`((reqest: Request, identifier: string) => string) | undefined`} />
29
+ <MemberInfo kind="property" type={``((reqest: Request, identifier: string) => string) | undefined``} />
30
30
 
31
31
 
32
32
  ### constructor
33
33
 
34
- <MemberInfo kind="method" type={`(uploadPath: string, toAbsoluteUrlFn?: (reqest: Request, identifier: string) => string) => LocalAssetStorageStrategy`} />
34
+ <MemberInfo kind="method" type={`(uploadPath: string, toAbsoluteUrlFn?: `(reqest: Request, identifier: string) => string`) => LocalAssetStorageStrategy`} />
35
35
 
36
36
 
37
37
  ### writeFileFromStream
38
38
 
39
- <MemberInfo kind="method" type={`(fileName: string, data: ReadStream) => Promise<string>`} />
39
+ <MemberInfo kind="method" type={`(fileName: string, data: ReadStream) => `Promise<string>``} />
40
40
 
41
41
 
42
42
  ### writeFileFromBuffer
43
43
 
44
- <MemberInfo kind="method" type={`(fileName: string, data: Buffer) => Promise<string>`} />
44
+ <MemberInfo kind="method" type={`(fileName: string, data: Buffer) => `Promise<string>``} />
45
45
 
46
46
 
47
47
  ### fileExists
48
48
 
49
- <MemberInfo kind="method" type={`(fileName: string) => Promise<boolean>`} />
49
+ <MemberInfo kind="method" type={`(fileName: string) => `Promise<boolean>``} />
50
50
 
51
51
 
52
52
  ### readFileToBuffer
53
53
 
54
- <MemberInfo kind="method" type={`(identifier: string) => Promise<Buffer>`} />
54
+ <MemberInfo kind="method" type={`(identifier: string) => `Promise<Buffer>``} />
55
55
 
56
56
 
57
57
  ### readFileToStream
58
58
 
59
- <MemberInfo kind="method" type={`(identifier: string) => Promise<Stream>`} />
59
+ <MemberInfo kind="method" type={`(identifier: string) => `Promise<Stream>``} />
60
60
 
61
61
 
62
62
  ### deleteFile
63
63
 
64
- <MemberInfo kind="method" type={`(identifier: string) => Promise<void>`} />
64
+ <MemberInfo kind="method" type={`(identifier: string) => `Promise<void>``} />
65
65
 
66
66
 
67
67
 
@@ -61,7 +61,7 @@ class PresetOnlyStrategy implements ImageTransformStrategy {
61
61
  <MemberInfo kind="method" type={`({
62
62
  input,
63
63
  availablePresets,
64
- }: <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#getimagetransformparametersargs'>GetImageTransformParametersArgs</a>) => Promise<<a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>> | <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>`} />
64
+ }: <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#getimagetransformparametersargs'>GetImageTransformParametersArgs</a>) => `Promise<`<a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>`> | `<a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>`} />
65
65
 
66
66
 
67
67
 
@@ -41,7 +41,7 @@ class S3AssetStorageStrategy implements AssetStorageStrategy {
41
41
 
42
42
  ### constructor
43
43
 
44
- <MemberInfo kind="method" type={`(s3Config: <a href='/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy#s3config'>S3Config</a>, toAbsoluteUrl: (request: Request, identifier: string) => string) => S3AssetStorageStrategy`} />
44
+ <MemberInfo kind="method" type={`(s3Config: <a href='/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy#s3config'>S3Config</a>, toAbsoluteUrl: `(request: Request, identifier: string) => string`) => S3AssetStorageStrategy`} />
45
45
 
46
46
 
47
47
  ### init
@@ -51,7 +51,7 @@ class S3AssetStorageStrategy implements AssetStorageStrategy {
51
51
 
52
52
  ### destroy
53
53
 
54
- <MemberInfo kind="property" type={`(() => void | Promise<void>) | undefined`} />
54
+ <MemberInfo kind="property" type={``(() => void | Promise<void>) | undefined``} />
55
55
 
56
56
 
57
57
  ### writeFileFromBuffer
@@ -43,7 +43,7 @@ class SharpAssetPreviewStrategy implements AssetPreviewStrategy {
43
43
 
44
44
  ### generatePreviewImage
45
45
 
46
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, mimeType: string, data: Buffer) => Promise<Buffer>`} />
46
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, mimeType: string, data: Buffer) => `Promise<Buffer>``} />
47
47
 
48
48
 
49
49
 
@@ -88,7 +88,7 @@ class DashboardPlugin implements NestModule {
88
88
 
89
89
  ### init
90
90
 
91
- <MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/dashboard-plugin/dashboard-plugin-options#dashboardpluginoptions'>DashboardPluginOptions</a>) => Type<<a href='/reference/core-plugins/dashboard-plugin/#dashboardplugin'>DashboardPlugin</a>>`} />
91
+ <MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/dashboard-plugin/dashboard-plugin-options#dashboardpluginoptions'>DashboardPluginOptions</a>) => `Type<`<a href='/reference/core-plugins/dashboard-plugin/#dashboardplugin'>DashboardPlugin</a>`>``} />
92
92
 
93
93
  Set the plugin options
94
94
  ### configure
@@ -170,7 +170,7 @@ bulk operation is executed.
170
170
  Configuration of the internal Elasticsearch query.
171
171
  ### customProductMappings
172
172
 
173
- <MemberInfo kind="property" type={`{ [fieldName: string]: CustomMapping< [<a href='/reference/typescript-api/entities/product#product'>Product</a>, <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>[], <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>, <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>] >; }`} />
173
+ <MemberInfo kind="property" type={``{ [fieldName: string]: CustomMapping< [`<a href='/reference/typescript-api/entities/product#product'>Product</a>, <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>[], <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>, <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>`] >; }``} />
174
174
 
175
175
  Custom mappings may be defined which will add the defined data to the
176
176
  Elasticsearch index and expose that data via the SearchResult GraphQL type,
@@ -233,7 +233,7 @@ query SearchProducts($input: SearchInput!) {
233
233
  ```
234
234
  ### customProductVariantMappings
235
235
 
236
- <MemberInfo kind="property" type={`{ [fieldName: string]: CustomMapping<[<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>, <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>, <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>]>; }`} />
236
+ <MemberInfo kind="property" type={``{ [fieldName: string]: CustomMapping<[`<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>, <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>, <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>`]>; }``} />
237
237
 
238
238
  This config option defines custom mappings which are accessible when the "groupByProduct" and "groupBySKU"
239
239
  input options are both set to `false`. In addition, custom product mappings can be accessed by using
@@ -274,7 +274,7 @@ and also performs optimizations to minimize the amount of work that needs to be
274
274
  the worker.
275
275
  ### hydrateProductRelations
276
276
 
277
- <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/common/entity-relation-paths#entityrelationpaths'>EntityRelationPaths</a>`<<a href='/reference/typescript-api/entities/product#product'>`Product</a>>>`} default={`[]`} since="1.3.0" />
277
+ <MemberInfo kind="property" type={``Array<`<a href='/reference/typescript-api/common/entity-relation-paths#entityrelationpaths'>EntityRelationPaths</a>`<`<a href='/reference/typescript-api/entities/product#product'>Product</a>`>>``} default={`[]`} since="1.3.0" />
278
278
 
279
279
  Additional product relations that will be fetched from DB while reindexing. This can be used
280
280
  in combination with `customProductMappings` to ensure that the required relations are joined
@@ -297,13 +297,13 @@ before the `product` object is passed to the `valueFn`.
297
297
  ```
298
298
  ### hydrateProductVariantRelations
299
299
 
300
- <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/common/entity-relation-paths#entityrelationpaths'>EntityRelationPaths</a>`<<a href='/reference/typescript-api/entities/product-variant#productvariant'>`ProductVariant</a>>>`} default={`[]`} since="1.3.0" />
300
+ <MemberInfo kind="property" type={``Array<`<a href='/reference/typescript-api/common/entity-relation-paths#entityrelationpaths'>EntityRelationPaths</a>`<`<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>`>>``} default={`[]`} since="1.3.0" />
301
301
 
302
302
  Additional variant relations that will be fetched from DB while reindexing. See
303
303
  `hydrateProductRelations` for more explanation and a usage example.
304
304
  ### extendSearchInputType
305
305
 
306
- <MemberInfo kind="property" type={`{ [name: string]: PrimitiveTypeVariations<GraphQlPrimitive>; }`} default={`{}`} since="1.3.0" />
306
+ <MemberInfo kind="property" type={``{ [name: string]: PrimitiveTypeVariations<GraphQlPrimitive>; }``} default={`{}`} since="1.3.0" />
307
307
 
308
308
  Allows the `SearchInput` type to be extended with new input fields. This allows arbitrary
309
309
  data to be passed in, which can then be used e.g. in the `mapQuery()` function or
@@ -459,7 +459,7 @@ The interval used to group search results into buckets according to price range.
459
459
  ```
460
460
  ### mapQuery
461
461
 
462
- <MemberInfo kind="property" type={`( query: any, input: ElasticSearchInput, searchConfig: DeepRequired<<a href='/reference/core-plugins/elasticsearch-plugin/elasticsearch-options#searchconfig'>SearchConfig</a>>, channelId: <a href='/reference/typescript-api/common/id#id'>ID</a>, enabledOnly: boolean, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, ) => any`} />
462
+ <MemberInfo kind="property" type={``( query: any, input: ElasticSearchInput, searchConfig: DeepRequired<`<a href='/reference/core-plugins/elasticsearch-plugin/elasticsearch-options#searchconfig'>SearchConfig</a>`>, channelId: `<a href='/reference/typescript-api/common/id#id'>ID</a>, enabledOnly: boolean, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>`, ) => any``} />
463
463
 
464
464
  This config option allows the the modification of the whole (already built) search query. This allows
465
465
  for e.g. wildcard / fuzzy searches on the index.
@@ -498,7 +498,7 @@ mapQuery: (query, input, searchConfig, channelId, enabledOnly, ctx) => {
498
498
  ```
499
499
  ### scriptFields
500
500
 
501
- <MemberInfo kind="property" type={`{ [fieldName: string]: CustomScriptMapping<[ElasticSearchInput]> }`} since="1.3.0" />
501
+ <MemberInfo kind="property" type={``{ [fieldName: string]: CustomScriptMapping<[ElasticSearchInput]> }``} since="1.3.0" />
502
502
 
503
503
  Sets `script_fields` inside the elasticsearch body which allows returning a script evaluation for each hit.
504
504
 
@@ -559,7 +559,7 @@ searchConfig: {
559
559
  ```
560
560
  ### mapSort
561
561
 
562
- <MemberInfo kind="property" type={`(sort: ElasticSearchSortInput, input: ElasticSearchInput) => ElasticSearchSortInput`} default={`{}`} since="1.4.0" />
562
+ <MemberInfo kind="property" type={``(sort: ElasticSearchSortInput, input: ElasticSearchInput) => ElasticSearchSortInput``} default={`{}`} since="1.4.0" />
563
563
 
564
564
  Allows extending the `sort` input of the elasticsearch body as covered in
565
565
  [Elasticsearch sort docs](https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html)
@@ -180,7 +180,7 @@ class ElasticsearchPlugin implements OnApplicationBootstrap {
180
180
 
181
181
  ### init
182
182
 
183
- <MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/elasticsearch-plugin/elasticsearch-options#elasticsearchoptions'>ElasticsearchOptions</a>) => Type<<a href='/reference/core-plugins/elasticsearch-plugin/#elasticsearchplugin'>ElasticsearchPlugin</a>>`} />
183
+ <MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/elasticsearch-plugin/elasticsearch-options#elasticsearchoptions'>ElasticsearchOptions</a>) => `Type<`<a href='/reference/core-plugins/elasticsearch-plugin/#elasticsearchplugin'>ElasticsearchPlugin</a>`>``} />
184
184
 
185
185
 
186
186
 
@@ -20,7 +20,7 @@ class EmailEventHandlerWithAsyncData<Data, T extends string = string, InputEvent
20
20
 
21
21
  ### constructor
22
22
 
23
- <MemberInfo kind="method" type={`(_loadDataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loaddatafn'>LoadDataFn</a>`<InputEvent, Data>`, listener: <a href='/reference/core-plugins/email-plugin/email-event-listener#emaileventlistener'>EmailEventListener</a>`<T>`, event: Type<InputEvent>) => EmailEventHandlerWithAsyncData`} />
23
+ <MemberInfo kind="method" type={`(_loadDataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loaddatafn'>LoadDataFn</a>`<InputEvent, Data>`, listener: <a href='/reference/core-plugins/email-plugin/email-event-listener#emaileventlistener'>EmailEventListener</a>`<T>`, event: `Type<InputEvent>`) => EmailEventHandlerWithAsyncData`} />
24
24
 
25
25
 
26
26
 
@@ -152,18 +152,18 @@ class EmailEventHandler<T extends string = string, Event extends EventWithContex
152
152
 
153
153
  ### constructor
154
154
 
155
- <MemberInfo kind="method" type={`(listener: <a href='/reference/core-plugins/email-plugin/email-event-listener#emaileventlistener'>EmailEventListener</a>`<T>`, event: Type<Event>) => EmailEventHandler`} />
155
+ <MemberInfo kind="method" type={`(listener: <a href='/reference/core-plugins/email-plugin/email-event-listener#emaileventlistener'>EmailEventListener</a>`<T>`, event: `Type<Event>`) => EmailEventHandler`} />
156
156
 
157
157
 
158
158
  ### filter
159
159
 
160
- <MemberInfo kind="method" type={`(filterFn: (event: Event) => boolean) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>`<T, Event>``} />
160
+ <MemberInfo kind="method" type={`(filterFn: `(event: Event) => boolean`) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>`<T, Event>``} />
161
161
 
162
162
  Defines a predicate function which is used to determine whether the event will trigger an email.
163
163
  Multiple filter functions may be defined.
164
164
  ### setRecipient
165
165
 
166
- <MemberInfo kind="method" type={`(setRecipientFn: (event: Event) => string) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>`<T, Event>``} />
166
+ <MemberInfo kind="method" type={`(setRecipientFn: `(event: Event) => string`) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>`<T, Event>``} />
167
167
 
168
168
  A function which defines how the recipient email address should be extracted from the incoming event.
169
169
 
@@ -172,7 +172,7 @@ Or with a formatted name (includes unicode support): `'Ноде Майлер <fo
172
172
  Or a comma-separated list of addresses: `'foobar@example.com, "Ноде Майлер" <bar@example.com>'`
173
173
  ### setLanguageCode
174
174
 
175
- <MemberInfo kind="method" type={`(setLanguageCodeFn: (event: Event) => <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a> | undefined) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>`<T, Event>``} since="1.8.0" />
175
+ <MemberInfo kind="method" type={`(setLanguageCodeFn: `(event: Event) => `<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a> | undefined) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>`<T, Event>``} since="1.8.0" />
176
176
 
177
177
  A function which allows to override the language of the email. If not defined, the language from the context will be used.
178
178
  ### setTemplateVars
@@ -259,7 +259,7 @@ Add configuration for another template other than the default `"body.hbs"`. Use
259
259
  templates for channels or languageCodes other than the default.
260
260
  ### loadData
261
261
 
262
- <MemberInfo kind="method" type={`(loadDataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loaddatafn'>LoadDataFn</a>`<Event, R>`) => <a href='/reference/core-plugins/email-plugin/email-event-handler-with-async-data#emaileventhandlerwithasyncdata'>EmailEventHandlerWithAsyncData</a>`<R, T, Event, <a href='/reference/core-plugins/email-plugin/email-plugin-types#eventwithasyncdata'>`EventWithAsyncData</a>`<Event, R>`>`} />
262
+ <MemberInfo kind="method" type={`(loadDataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loaddatafn'>LoadDataFn</a>`<Event, R>`) => <a href='/reference/core-plugins/email-plugin/email-event-handler-with-async-data#emaileventhandlerwithasyncdata'>EmailEventHandlerWithAsyncData</a>`<R, T, Event, `<a href='/reference/core-plugins/email-plugin/email-plugin-types#eventwithasyncdata'>EventWithAsyncData</a>`<Event, R>>``} />
263
263
 
264
264
  Allows data to be loaded asynchronously which can then be used as template variables.
265
265
  The `loadDataFn` has access to the event, the TypeORM `Connection` object, and an
@@ -285,7 +285,7 @@ new EmailEventListener('order-confirmation')
285
285
  ```
286
286
  ### setMockEvent
287
287
 
288
- <MemberInfo kind="method" type={`(event: Omit<Event, 'ctx' | 'data'>) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>`<T, Event>``} />
288
+ <MemberInfo kind="method" type={`(event: `Omit<Event, 'ctx' | 'data'>`) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>`<T, Event>``} />
289
289
 
290
290
  Optionally define a mock Event which is used by the dev mode mailbox app for generating mock emails
291
291
  from this handler, which is useful when developing the email templates.
@@ -29,7 +29,7 @@ class EmailEventListener<T extends string> {
29
29
 
30
30
  ### on
31
31
 
32
- <MemberInfo kind="method" type={`(event: Type<Event>) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>`<T, Event>``} />
32
+ <MemberInfo kind="method" type={`(event: `Type<Event>`) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>`<T, Event>``} />
33
33
 
34
34
  Defines the event to listen for.
35
35
 
@@ -25,12 +25,12 @@ interface EmailGenerator<T extends string = any, E extends VendureEvent = any> e
25
25
 
26
26
  ### onInit
27
27
 
28
- <MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/email-plugin/email-plugin-options#emailpluginoptions'>EmailPluginOptions</a>) => void | Promise<void>`} />
28
+ <MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/email-plugin/email-plugin-options#emailpluginoptions'>EmailPluginOptions</a>) => `void | Promise<void>``} />
29
29
 
30
30
  Any necessary setup can be performed here.
31
31
  ### generate
32
32
 
33
- <MemberInfo kind="method" type={`(from: string, subject: string, body: string, templateVars: { [key: string]: any }) => Pick<<a href='/reference/core-plugins/email-plugin/email-plugin-types#emaildetails'>EmailDetails</a>, 'from' | 'subject' | 'body'>`} />
33
+ <MemberInfo kind="method" type={`(from: string, subject: string, body: string, templateVars: { [key: string]: any }) => `Pick<`<a href='/reference/core-plugins/email-plugin/email-plugin-types#emaildetails'>EmailDetails</a>`, 'from' | 'subject' | 'body'>``} />
34
34
 
35
35
  Given a subject and body from an email template, this method generates the final
36
36
  interpolated email text.
@@ -39,12 +39,12 @@ An optional TemplateLoader which can be used to load templates from a custom loc
39
39
  The default uses the FileBasedTemplateLoader which loads templates from `<project root>/vendure/email/templates`
40
40
  ### transport
41
41
 
42
- <MemberInfo kind="property" type={`| <a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a> | (( injector?: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, ) => <a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a> | Promise<<a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a>>)`} />
42
+ <MemberInfo kind="property" type={`| <a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a> | (( injector?: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>`, ) => `<a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a>` | Promise<`<a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a>`>)``} />
43
43
 
44
44
  Configures how the emails are sent.
45
45
  ### handlers
46
46
 
47
- <MemberInfo kind="property" type={`Array<<a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>`<string, any>`>`} />
47
+ <MemberInfo kind="property" type={``Array<`<a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>`<string, any>>``} />
48
48
 
49
49
  An array of <DocsLink href="/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler">EmailEventHandler</DocsLink>s which define which Vendure events will trigger
50
50
  emails, and how those emails are generated.
@@ -60,7 +60,7 @@ interface EmailDetails<Type extends 'serialized' | 'unserialized' = 'unserialize
60
60
 
61
61
  ### attachments
62
62
 
63
- <MemberInfo kind="property" type={`Array<Type extends 'serialized' ? SerializedAttachment : Attachment>`} />
63
+ <MemberInfo kind="property" type={``Array<Type extends 'serialized' ? SerializedAttachment : Attachment>``} />
64
64
 
65
65
 
66
66
  ### cc
@@ -52,7 +52,7 @@ interface EmailSender extends InjectableStrategy {
52
52
 
53
53
  ### send
54
54
 
55
- <MemberInfo kind="property" type={`(email: <a href='/reference/core-plugins/email-plugin/email-plugin-types#emaildetails'>EmailDetails</a>, options: <a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a>) => void | Promise<void>`} />
55
+ <MemberInfo kind="property" type={`(email: <a href='/reference/core-plugins/email-plugin/email-plugin-types#emaildetails'>EmailDetails</a>, options: <a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a>`) => void | Promise<void>``} />
56
56
 
57
57
 
58
58
 
@@ -286,7 +286,7 @@ class EmailPlugin implements OnApplicationBootstrap, OnApplicationShutdown, Nest
286
286
 
287
287
  ### init
288
288
 
289
- <MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/email-plugin/email-plugin-options#emailpluginoptions'>EmailPluginOptions</a> | <a href='/reference/core-plugins/email-plugin/email-plugin-options#emailplugindevmodeoptions'>EmailPluginDevModeOptions</a>) => Type<<a href='/reference/core-plugins/email-plugin/#emailplugin'>EmailPlugin</a>>`} />
289
+ <MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/email-plugin/email-plugin-options#emailpluginoptions'>EmailPluginOptions</a> | <a href='/reference/core-plugins/email-plugin/email-plugin-options#emailplugindevmodeoptions'>EmailPluginDevModeOptions</a>) => `Type<`<a href='/reference/core-plugins/email-plugin/#emailplugin'>EmailPlugin</a>`>``} />
290
290
 
291
291
 
292
292
  ### onApplicationShutdown
@@ -37,12 +37,12 @@ interface TemplateLoader {
37
37
 
38
38
  ### loadTemplate
39
39
 
40
- <MemberInfo kind="method" type={`(injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loadtemplateinput'>LoadTemplateInput</a>) => Promise<string>`} />
40
+ <MemberInfo kind="method" type={`(injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loadtemplateinput'>LoadTemplateInput</a>) => `Promise<string>``} />
41
41
 
42
42
  Load template and return it's content as a string
43
43
  ### loadPartials
44
44
 
45
- <MemberInfo kind="method" type={`() => Promise<Partial[]>`} />
45
+ <MemberInfo kind="method" type={`() => `Promise<Partial[]>``} />
46
46
 
47
47
  Load partials and return their contents.
48
48
  This method is only called during initialization, i.e. during server startup.
@@ -74,12 +74,12 @@ class FileBasedTemplateLoader implements TemplateLoader {
74
74
 
75
75
  ### loadTemplate
76
76
 
77
- <MemberInfo kind="method" type={`(_injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, _ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, { type, templateName }: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loadtemplateinput'>LoadTemplateInput</a>) => Promise<string>`} />
77
+ <MemberInfo kind="method" type={`(_injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, _ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, { type, templateName }: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loadtemplateinput'>LoadTemplateInput</a>) => `Promise<string>``} />
78
78
 
79
79
 
80
80
  ### loadPartials
81
81
 
82
- <MemberInfo kind="method" type={`() => Promise<Partial[]>`} />
82
+ <MemberInfo kind="method" type={`() => `Promise<Partial[]>``} />
83
83
 
84
84
 
85
85
 
@@ -204,7 +204,7 @@ interface TestingTransportOptions {
204
204
 
205
205
  ### onSend
206
206
 
207
- <MemberInfo kind="property" type={`(details: <a href='/reference/core-plugins/email-plugin/email-plugin-types#emaildetails'>EmailDetails</a>) => void`} />
207
+ <MemberInfo kind="property" type={`(details: <a href='/reference/core-plugins/email-plugin/email-plugin-types#emaildetails'>EmailDetails</a>`) => void``} />
208
208
 
209
209
  Callback to be invoked when an email would be sent.
210
210
 
@@ -61,7 +61,7 @@ class GraphiqlPlugin implements NestModule {
61
61
 
62
62
  ### options
63
63
 
64
- <MemberInfo kind="property" type={`Required<GraphiqlPluginOptions>`} />
64
+ <MemberInfo kind="property" type={``Required<GraphiqlPluginOptions>``} />
65
65
 
66
66
 
67
67
  ### constructor
@@ -71,7 +71,7 @@ class GraphiqlPlugin implements NestModule {
71
71
 
72
72
  ### init
73
73
 
74
- <MemberInfo kind="method" type={`(options: GraphiqlPluginOptions = {}) => Type<<a href='/reference/core-plugins/graphiql-plugin/#graphiqlplugin'>GraphiqlPlugin</a>>`} />
74
+ <MemberInfo kind="method" type={`(options: GraphiqlPluginOptions = {}) => `Type<`<a href='/reference/core-plugins/graphiql-plugin/#graphiqlplugin'>GraphiqlPlugin</a>`>``} />
75
75
 
76
76
 
77
77
  ### configure
@@ -85,7 +85,7 @@ When set to `'prod'`, the plugin will disable dev-mode features of the GraphQL A
85
85
  - GraphQL playground
86
86
  ### skip
87
87
 
88
- <MemberInfo kind="property" type={`(context: GraphQLRequestContext<any>) => Promise<boolean> | boolean`} />
88
+ <MemberInfo kind="property" type={``(context: GraphQLRequestContext<any>) => Promise<boolean> | boolean``} />
89
89
 
90
90
  Allows you to skip the complexity check for certain requests.
91
91
 
@@ -35,7 +35,7 @@ class BullMQJobQueueStrategy implements InspectableJobQueueStrategy {
35
35
 
36
36
  ### init
37
37
 
38
- <MemberInfo kind="method" type={`(injector: Injector) => Promise<void>`} />
38
+ <MemberInfo kind="method" type={`(injector: Injector) => `Promise<void>``} />
39
39
 
40
40
 
41
41
  ### destroy
@@ -45,42 +45,42 @@ class BullMQJobQueueStrategy implements InspectableJobQueueStrategy {
45
45
 
46
46
  ### add
47
47
 
48
- <MemberInfo kind="method" type={`(job: Job<Data>) => Promise<Job<Data>>`} />
48
+ <MemberInfo kind="method" type={`(job: `Job<Data>`) => `Promise<Job<Data>>``} />
49
49
 
50
50
 
51
51
  ### cancelJob
52
52
 
53
- <MemberInfo kind="method" type={`(jobId: string) => Promise<Job | undefined>`} />
53
+ <MemberInfo kind="method" type={`(jobId: string) => `Promise<Job | undefined>``} />
54
54
 
55
55
 
56
56
  ### findMany
57
57
 
58
- <MemberInfo kind="method" type={`(options?: JobListOptions) => Promise<PaginatedList<Job>>`} />
58
+ <MemberInfo kind="method" type={`(options?: JobListOptions) => `Promise<PaginatedList<Job>>``} />
59
59
 
60
60
 
61
61
  ### findManyById
62
62
 
63
- <MemberInfo kind="method" type={`(ids: ID[]) => Promise<Job[]>`} />
63
+ <MemberInfo kind="method" type={`(ids: ID[]) => `Promise<Job[]>``} />
64
64
 
65
65
 
66
66
  ### findOne
67
67
 
68
- <MemberInfo kind="method" type={`(id: ID) => Promise<Job | undefined>`} />
68
+ <MemberInfo kind="method" type={`(id: ID) => `Promise<Job | undefined>``} />
69
69
 
70
70
 
71
71
  ### removeSettledJobs
72
72
 
73
- <MemberInfo kind="method" type={`(queueNames?: string[], olderThan?: Date) => Promise<number>`} />
73
+ <MemberInfo kind="method" type={`(queueNames?: string[], olderThan?: Date) => `Promise<number>``} />
74
74
 
75
75
 
76
76
  ### start
77
77
 
78
- <MemberInfo kind="method" type={`(queueName: string, process: (job: Job<Data>) => Promise<any>) => Promise<void>`} />
78
+ <MemberInfo kind="method" type={`(queueName: string, process: `(job: Job<Data>) => Promise<any>`) => `Promise<void>``} />
79
79
 
80
80
 
81
81
  ### stop
82
82
 
83
- <MemberInfo kind="method" type={`(queueName: string, process: (job: Job<Data>) => Promise<any>) => Promise<void>`} />
83
+ <MemberInfo kind="method" type={`(queueName: string, process: `(job: Job<Data>) => Promise<any>`) => `Promise<void>``} />
84
84
 
85
85
 
86
86