@vendure/docs 0.0.0-202601211543 → 0.0.0-202601211551

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 (103) hide show
  1. package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +4 -4
  2. package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +1 -1
  3. package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +1 -1
  4. package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -1
  5. package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +1 -1
  6. package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +1 -1
  7. package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx +1 -1
  8. package/docs/reference/admin-ui-api/routes/register-route-component.mdx +1 -1
  9. package/docs/reference/admin-ui-api/services/data-service.mdx +3 -3
  10. package/docs/reference/admin-ui-api/services/modal-service.mdx +2 -2
  11. package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +2 -2
  12. package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +2 -2
  13. package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +13 -13
  14. package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
  15. package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +2 -2
  16. package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +1 -1
  17. package/docs/reference/dashboard/detail-views/detail-page.mdx +1 -1
  18. package/docs/reference/dashboard/detail-views/use-detail-page.mdx +1 -1
  19. package/docs/reference/dashboard/detail-views/use-generated-form.mdx +1 -1
  20. package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
  21. package/docs/reference/dashboard/list-views/data-table.mdx +1 -1
  22. package/docs/reference/dashboard/list-views/list-page.mdx +1 -1
  23. package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +1 -1
  24. package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +1 -1
  25. package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +1 -1
  26. package/docs/reference/typescript-api/configurable-operation-def/index.mdx +1 -1
  27. package/docs/reference/typescript-api/configuration/collection-filter.mdx +1 -1
  28. package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +4 -4
  29. package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +2 -2
  30. package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
  31. package/docs/reference/typescript-api/configuration/vendure-config.mdx +1 -1
  32. package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
  33. package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
  34. package/docs/reference/typescript-api/data-access/list-query-builder.mdx +1 -1
  35. package/docs/reference/typescript-api/data-access/transactional-connection.mdx +1 -1
  36. package/docs/reference/typescript-api/entities/promotion.mdx +1 -1
  37. package/docs/reference/typescript-api/events/event-bus.mdx +1 -1
  38. package/docs/reference/typescript-api/events/event-types.mdx +29 -29
  39. package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +5 -5
  40. package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +4 -4
  41. package/docs/reference/typescript-api/import-export/import-parser.mdx +1 -1
  42. package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +2 -2
  43. package/docs/reference/typescript-api/job-queue/index.mdx +2 -2
  44. package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +1 -1
  45. package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
  46. package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +5 -5
  47. package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +3 -3
  48. package/docs/reference/typescript-api/job-queue/job.mdx +3 -3
  49. package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +2 -2
  50. package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +3 -3
  51. package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +3 -3
  52. package/docs/reference/typescript-api/job-queue/types.mdx +1 -1
  53. package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +1 -1
  54. package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
  55. package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
  56. package/docs/reference/typescript-api/orders/order-process.mdx +4 -4
  57. package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +6 -6
  58. package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +4 -4
  59. package/docs/reference/typescript-api/payment/payment-method-handler.mdx +2 -2
  60. package/docs/reference/typescript-api/payment/payment-options.mdx +3 -3
  61. package/docs/reference/typescript-api/payment/payment-process.mdx +4 -4
  62. package/docs/reference/typescript-api/payment/refund-process.mdx +4 -4
  63. package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
  64. package/docs/reference/typescript-api/promotions/promotion-action.mdx +21 -21
  65. package/docs/reference/typescript-api/promotions/promotion-condition.mdx +4 -4
  66. package/docs/reference/typescript-api/promotions/promotion-options.mdx +2 -2
  67. package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +3 -3
  68. package/docs/reference/typescript-api/services/administrator-service.mdx +1 -1
  69. package/docs/reference/typescript-api/services/asset-service.mdx +1 -1
  70. package/docs/reference/typescript-api/services/channel-service.mdx +3 -3
  71. package/docs/reference/typescript-api/services/collection-service.mdx +2 -2
  72. package/docs/reference/typescript-api/services/country-service.mdx +1 -1
  73. package/docs/reference/typescript-api/services/customer-group-service.mdx +2 -2
  74. package/docs/reference/typescript-api/services/customer-service.mdx +5 -5
  75. package/docs/reference/typescript-api/services/facet-service.mdx +2 -2
  76. package/docs/reference/typescript-api/services/facet-value-service.mdx +2 -2
  77. package/docs/reference/typescript-api/services/history-service.mdx +2 -2
  78. package/docs/reference/typescript-api/services/order-service.mdx +18 -18
  79. package/docs/reference/typescript-api/services/payment-method-service.mdx +1 -1
  80. package/docs/reference/typescript-api/services/product-option-service.mdx +1 -1
  81. package/docs/reference/typescript-api/services/product-service.mdx +2 -2
  82. package/docs/reference/typescript-api/services/product-variant-service.mdx +3 -3
  83. package/docs/reference/typescript-api/services/promotion-service.mdx +3 -3
  84. package/docs/reference/typescript-api/services/province-service.mdx +1 -1
  85. package/docs/reference/typescript-api/services/role-service.mdx +1 -1
  86. package/docs/reference/typescript-api/services/seller-service.mdx +1 -1
  87. package/docs/reference/typescript-api/services/settings-store-service.mdx +6 -6
  88. package/docs/reference/typescript-api/services/shipping-method-service.mdx +1 -1
  89. package/docs/reference/typescript-api/services/stock-location-service.mdx +1 -1
  90. package/docs/reference/typescript-api/services/stock-movement-service.mdx +1 -1
  91. package/docs/reference/typescript-api/services/tag-service.mdx +1 -1
  92. package/docs/reference/typescript-api/services/tax-category-service.mdx +1 -1
  93. package/docs/reference/typescript-api/services/tax-rate-service.mdx +1 -1
  94. package/docs/reference/typescript-api/services/user-service.mdx +1 -1
  95. package/docs/reference/typescript-api/services/zone-service.mdx +1 -1
  96. package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +1 -1
  97. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +3 -3
  98. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +2 -2
  99. package/docs/reference/typescript-api/shipping/shipping-options.mdx +5 -5
  100. package/docs/reference/typescript-api/state-machine/fsm.mdx +1 -1
  101. package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +4 -4
  102. package/docs/reference/typescript-api/testing/register-initializer.mdx +1 -1
  103. package/package.json +1 -1
@@ -37,7 +37,7 @@ interface BulkAction<ItemType = any, ComponentType = any> {
37
37
 
38
38
  ### getTranslationVars
39
39
 
40
- <MemberInfo kind="property" type={`( context: <a href='/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionfunctioncontext'>BulkActionFunctionContext</a><ItemType, ComponentType>, ) => Record<string, string | number> | Promise<Record<string, string | number>>`} />
40
+ <MemberInfo kind="property" type={`( context: <a href='/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionfunctioncontext'>BulkActionFunctionContext</a>`<ItemType, ComponentType>`, ) => Record<string, string | number> | Promise<Record<string, string | number>>`} />
41
41
 
42
42
  An optional function that should resolve to a map of translation variables which can be
43
43
  used when translating the `label` string.
@@ -60,12 +60,12 @@ A class to be added to the icon element. Examples:
60
60
  - is-highlight
61
61
  ### onClick
62
62
 
63
- <MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionclickcontext'>BulkActionClickContext</a><ItemType, ComponentType>) => void`} />
63
+ <MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionclickcontext'>BulkActionClickContext</a>`<ItemType, ComponentType>`) => void`} />
64
64
 
65
65
  Defines the logic that executes when the bulk action button is clicked.
66
66
  ### isVisible
67
67
 
68
- <MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionfunctioncontext'>BulkActionFunctionContext</a><ItemType, ComponentType>) => boolean | Promise<boolean>`} />
68
+ <MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionfunctioncontext'>BulkActionFunctionContext</a>`<ItemType, ComponentType>`) => boolean | Promise<boolean>`} />
69
69
 
70
70
  A function that determines whether this bulk action item should be displayed in the menu.
71
71
  If not defined, the item will always be displayed.
@@ -191,7 +191,7 @@ interface BulkActionClickContext<ItemType, ComponentType> extends BulkActionFunc
191
191
  event: MouseEvent;
192
192
  }
193
193
  ```
194
- * Extends: <DocsLink href="/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionfunctioncontext">`BulkActionFunctionContext`</DocsLink><ItemType, ComponentType>
194
+ * Extends: <DocsLink href="/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionfunctioncontext">`BulkActionFunctionContext`</DocsLink>`<ItemType, ComponentType>`
195
195
 
196
196
 
197
197
 
@@ -49,7 +49,7 @@ class AssetPickerDialogComponent implements OnInit, AfterViewInit, OnDestroy, Di
49
49
  createAssets(files: File[]) => ;
50
50
  }
51
51
  ```
52
- * Implements: OnInit, AfterViewInit, OnDestroy, <DocsLink href="/reference/admin-ui-api/services/modal-service#dialog">`Dialog`</DocsLink><<DocsLink href="/reference/typescript-api/entities/asset#asset">`Asset`</DocsLink>[]>
52
+ * Implements: OnInit, AfterViewInit, OnDestroy, <DocsLink href="/reference/admin-ui-api/services/modal-service#dialog">`Dialog`</DocsLink>`<`<DocsLink href="/reference/typescript-api/entities/asset#asset">`Asset`</DocsLink>`[]>`
53
53
 
54
54
 
55
55
 
@@ -22,7 +22,7 @@ class IfPermissionsDirective extends IfDirectiveBase<Array<Permission[] | null>>
22
22
  constructor(_viewContainer: ViewContainerRef, templateRef: TemplateRef<any>, changeDetectorRef: ChangeDetectorRef, permissionsService: PermissionsService)
23
23
  }
24
24
  ```
25
- * Extends: IfDirectiveBase<`Array<`<DocsLink href="/reference/typescript-api/common/permission#permission">`Permission`</DocsLink>[] | null>>
25
+ * Extends: `IfDirectiveBase<Array<`<DocsLink href="/reference/typescript-api/common/permission#permission">`Permission`</DocsLink>`[] | null>>`
26
26
 
27
27
 
28
28
 
@@ -43,5 +43,5 @@ Parameters
43
43
 
44
44
  ### config
45
45
 
46
- <MemberInfo kind="parameter" type={`{ component: Type<<a href='/reference/admin-ui-api/list-detail-views/typed-base-detail-component#typedbasedetailcomponent'>TypedBaseDetailComponent</a><T, Field>>; query: T; entityKey: R; getBreadcrumbs?: (entity: ResultOf<T>[R]) => BreadcrumbValue; variables?: T extends TypedDocumentNode<any, infer V> ? Omit<V, 'id'> : never; }`} />
46
+ <MemberInfo kind="parameter" type={`{ component: Type<<a href='/reference/admin-ui-api/list-detail-views/typed-base-detail-component#typedbasedetailcomponent'>TypedBaseDetailComponent</a>`<T, Field>`>; query: T; entityKey: R; getBreadcrumbs?: (entity: ResultOf<T>[R]) => BreadcrumbValue; variables?: T extends TypedDocumentNode<any, infer V> ? Omit<V, 'id'> : never; }`} />
47
47
 
@@ -15,7 +15,7 @@ class TypedBaseDetailComponent<T extends TypedDocumentNode<any, any>, Field exte
15
15
  init() => ;
16
16
  }
17
17
  ```
18
- * Extends: <DocsLink href="/reference/admin-ui-api/list-detail-views/base-detail-component#basedetailcomponent">`BaseDetailComponent`</DocsLink><NonNullable<ResultOf<T>[Field]>>
18
+ * Extends: <DocsLink href="/reference/admin-ui-api/list-detail-views/base-detail-component#basedetailcomponent">`BaseDetailComponent`</DocsLink>`<NonNullable<ResultOf<T>[Field]>>`
19
19
 
20
20
 
21
21
 
@@ -31,7 +31,7 @@ class TypedBaseListComponent<T extends TypedDocumentNode<any, Vars>, Field exten
31
31
  getCustomFieldConfig(key: Exclude<keyof CustomFields, '__typename'> | string) => CustomFieldConfig[];
32
32
  }
33
33
  ```
34
- * Extends: <DocsLink href="/reference/admin-ui-api/list-detail-views/base-list-component#baselistcomponent">`BaseListComponent`</DocsLink><ResultOf<T>, ItemOf<ResultOf<T>, Field>, VariablesOf<T>>
34
+ * Extends: <DocsLink href="/reference/admin-ui-api/list-detail-views/base-list-component#baselistcomponent">`BaseListComponent`</DocsLink>`<ResultOf<T>, ItemOf<ResultOf<T>, Field>, VariablesOf<T>>`
35
35
 
36
36
 
37
37
  * Implements: OnInit
@@ -13,5 +13,5 @@ Parameters
13
13
 
14
14
  ### options
15
15
 
16
- <MemberInfo kind="parameter" type={`<a href='/reference/admin-ui-api/react-extensions/register-react-route-component-options#registerreactroutecomponentoptions'>RegisterReactRouteComponentOptions</a><Entity, T, Field, R>`} />
16
+ <MemberInfo kind="parameter" type={`<a href='/reference/admin-ui-api/react-extensions/register-react-route-component-options#registerreactroutecomponentoptions'>RegisterReactRouteComponentOptions</a>`<Entity, T, Field, R>``} />
17
17
 
@@ -48,5 +48,5 @@ Parameters
48
48
 
49
49
  ### options
50
50
 
51
- <MemberInfo kind="parameter" type={`<a href='/reference/admin-ui-api/routes/register-route-component-options#registerroutecomponentoptions'>RegisterRouteComponentOptions</a><Component, Entity, T, Field, R>`} />
51
+ <MemberInfo kind="parameter" type={`<a href='/reference/admin-ui-api/routes/register-route-component-options#registerroutecomponentoptions'>RegisterRouteComponentOptions</a>`<Component, Entity, T, Field, R>``} />
52
52
 
@@ -20,7 +20,7 @@ class DataService {
20
20
 
21
21
  ### query
22
22
 
23
- <MemberInfo kind="method" type={`(query: DocumentNode | TypedDocumentNode<T, V>, variables?: V, fetchPolicy: WatchQueryFetchPolicy = 'cache-and-network', options: ExtendedQueryOptions = {}) => <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a><T, V>`} />
23
+ <MemberInfo kind="method" type={`(query: DocumentNode | TypedDocumentNode<T, V>, variables?: V, fetchPolicy: WatchQueryFetchPolicy = 'cache-and-network', options: ExtendedQueryOptions = {}) => <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a>`<T, V>``} />
24
24
 
25
25
  Perform a GraphQL query. Returns a <DocsLink href="/reference/admin-ui-api/services/data-service#queryresult">QueryResult</DocsLink> which allows further control over
26
26
  they type of result returned, e.g. stream of values, single value etc.
@@ -89,12 +89,12 @@ class QueryResult<T, V extends Record<string, any> = Record<string, any>> {
89
89
 
90
90
  ### refetchOnChannelChange
91
91
 
92
- <MemberInfo kind="method" type={`() => <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a><T, V>`} />
92
+ <MemberInfo kind="method" type={`() => <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a>`<T, V>``} />
93
93
 
94
94
  Re-fetch this query whenever the active Channel changes.
95
95
  ### refetchOnCustomFieldsChange
96
96
 
97
- <MemberInfo kind="method" type={`(customFieldsToInclude$: Observable<string[]>) => <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a><T, V>`} since="3.0.4" />
97
+ <MemberInfo kind="method" type={`(customFieldsToInclude$: Observable<string[]>) => <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a>`<T, V>``} since="3.0.4" />
98
98
 
99
99
  Re-fetch this query whenever the custom fields change, updating the query to include the
100
100
  specified custom fields.
@@ -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
 
@@ -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,7 +297,7 @@ 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.
@@ -12,7 +12,7 @@ class EmailEventHandlerWithAsyncData<Data, T extends string = string, InputEvent
12
12
  constructor(_loadDataFn: LoadDataFn<InputEvent, Data>, listener: EmailEventListener<T>, event: Type<InputEvent>)
13
13
  }
14
14
  ```
15
- * Extends: <DocsLink href="/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler">`EmailEventHandler`</DocsLink><T, Event>
15
+ * Extends: <DocsLink href="/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler">`EmailEventHandler`</DocsLink>`<T, Event>`
16
16
 
17
17
 
18
18
 
@@ -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,35 +172,35 @@ 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
179
179
 
180
- <MemberInfo kind="method" type={`(templateVarsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#settemplatevarsfn'>SetTemplateVarsFn</a><Event>) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
180
+ <MemberInfo kind="method" type={`(templateVarsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#settemplatevarsfn'>SetTemplateVarsFn</a>`<Event>`) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>`<T, Event>``} />
181
181
 
182
182
  A function which returns an object hash of variables which will be made available to the Handlebars template
183
183
  and subject line for interpolation.
184
184
  ### setSubject
185
185
 
186
- <MemberInfo kind="method" type={`(defaultSubject: string | <a href='/reference/core-plugins/email-plugin/email-plugin-types#setsubjectfn'>SetSubjectFn</a><Event>) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
186
+ <MemberInfo kind="method" type={`(defaultSubject: string | <a href='/reference/core-plugins/email-plugin/email-plugin-types#setsubjectfn'>SetSubjectFn</a>`<Event>`) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>`<T, Event>``} />
187
187
 
188
188
  Sets the default subject of the email. The subject string may use Handlebars variables defined by the
189
189
  setTemplateVars() method.
190
190
  ### setFrom
191
191
 
192
- <MemberInfo kind="method" type={`(from: string) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
192
+ <MemberInfo kind="method" type={`(from: string) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>`<T, Event>``} />
193
193
 
194
194
  Sets the default from field of the email. The from string may use Handlebars variables defined by the
195
195
  setTemplateVars() method.
196
196
  ### setOptionalAddressFields
197
197
 
198
- <MemberInfo kind="method" type={`(optionalAddressFieldsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setoptionaladdressfieldsfn'>SetOptionalAddressFieldsFn</a><Event>) => `} since="1.1.0" />
198
+ <MemberInfo kind="method" type={`(optionalAddressFieldsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setoptionaladdressfieldsfn'>SetOptionalAddressFieldsFn</a>`<Event>`) => `} since="1.1.0" />
199
199
 
200
200
  A function which allows <DocsLink href="/reference/core-plugins/email-plugin/email-plugin-types#optionaladdressfields">OptionalAddressFields</DocsLink> to be specified such as "cc" and "bcc".
201
201
  ### setMetadata
202
202
 
203
- <MemberInfo kind="method" type={`(optionalSetMetadataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setmetadatafn'>SetMetadataFn</a><Event>) => `} since="3.1.0" />
203
+ <MemberInfo kind="method" type={`(optionalSetMetadataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setmetadatafn'>SetMetadataFn</a>`<Event>`) => `} since="3.1.0" />
204
204
 
205
205
  A function which allows <DocsLink href="/reference/core-plugins/email-plugin/email-plugin-types#emailmetadata">EmailMetadata</DocsLink> to be specified for the email. This can be used
206
206
  to store arbitrary data about the email which can be used for tracking or other purposes.
@@ -225,7 +225,7 @@ It will be exposed in the <DocsLink href="/reference/core-plugins/email-plugin/e
225
225
  the order in another available way.
226
226
  ### setAttachments
227
227
 
228
- <MemberInfo kind="method" type={`(setAttachmentsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setattachmentsfn'>SetAttachmentsFn</a><Event>) => `} />
228
+ <MemberInfo kind="method" type={`(setAttachmentsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setattachmentsfn'>SetAttachmentsFn</a>`<Event>`) => `} />
229
229
 
230
230
  Defines one or more files to be attached to the email. An attachment can be specified
231
231
  as either a `path` (to a file or URL) or as `content` which can be a string, Buffer or Stream.
@@ -253,13 +253,13 @@ const testAttachmentHandler = new EmailEventListener('activate-voucher')
253
253
  ```
254
254
  ### addTemplate
255
255
 
256
- <MemberInfo kind="method" type={`(config: EmailTemplateConfig) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
256
+ <MemberInfo kind="method" type={`(config: EmailTemplateConfig) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>`<T, Event>``} />
257
257
 
258
258
  Add configuration for another template other than the default `"body.hbs"`. Use this method to define specific
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
 
@@ -44,7 +44,7 @@ The default uses the FileBasedTemplateLoader which loads templates from `<projec
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.
@@ -115,7 +115,7 @@ interface EmailPluginDevModeOptions extends Omit<EmailPluginOptions, 'transport'
115
115
  route: string;
116
116
  }
117
117
  ```
118
- * Extends: `Omit<`<DocsLink href="/reference/core-plugins/email-plugin/email-plugin-options#emailpluginoptions">`EmailPluginOptions`</DocsLink>, 'transport'>
118
+ * Extends: `Omit<`<DocsLink href="/reference/core-plugins/email-plugin/email-plugin-options#emailpluginoptions">`EmailPluginOptions`</DocsLink>`, 'transport'>`
119
119
 
120
120
 
121
121
 
@@ -36,7 +36,7 @@ class PurgeRule<Event extends VendureEvent = VendureEvent> {
36
36
 
37
37
  ### constructor
38
38
 
39
- <MemberInfo kind="method" type={`(config: <a href='/reference/core-plugins/stellate-plugin/purge-rule#purgeruleconfig'>PurgeRuleConfig</a><Event>) => PurgeRule`} />
39
+ <MemberInfo kind="method" type={`(config: <a href='/reference/core-plugins/stellate-plugin/purge-rule#purgeruleconfig'>PurgeRuleConfig</a>`<Event>`) => PurgeRule`} />
40
40
 
41
41
 
42
42
 
@@ -15,7 +15,7 @@ Parameters
15
15
 
16
16
  ### props
17
17
 
18
- <MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/detail-page#detailpageprops'>DetailPageProps</a><T, C, U>`} />
18
+ <MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/detail-page#detailpageprops'>DetailPageProps</a>`<T, C, U>``} />
19
19
 
20
20
  <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/detail-page.tsx" sourceLine="43" packageName="@vendure/dashboard" since="3.3.0" />
21
21
 
@@ -74,7 +74,7 @@ Parameters
74
74
 
75
75
  ### options
76
76
 
77
- <MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/use-detail-page#detailpageoptions'>DetailPageOptions</a><T, C, U, EntityField, VarNameCreate, VarNameUpdate>`} />
77
+ <MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/use-detail-page#detailpageoptions'>DetailPageOptions</a>`<T, C, U, EntityField, VarNameCreate, VarNameUpdate>``} />
78
78
 
79
79
  <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/use-detail-page.ts" sourceLine="46" packageName="@vendure/dashboard" since="3.3.0" />
80
80
 
@@ -36,7 +36,7 @@ Parameters
36
36
 
37
37
  ### options
38
38
 
39
- <MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/use-generated-form#generatedformoptions'>GeneratedFormOptions</a><T, VarName, E>`} />
39
+ <MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/use-generated-form#generatedformoptions'>GeneratedFormOptions</a>`<T, VarName, E>``} />
40
40
 
41
41
  <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/form-engine/use-generated-form.tsx" sourceLine="24" packageName="@vendure/dashboard" since="3.3.0" />
42
42
 
@@ -39,7 +39,7 @@ Parameters
39
39
 
40
40
  ### props
41
41
 
42
- <MemberInfo kind="parameter" type={`<a href='/reference/dashboard/form-components/form-field-wrapper#formfieldwrapperprops'>FormFieldWrapperProps</a><TFieldValues, TName>`} />
42
+ <MemberInfo kind="parameter" type={`<a href='/reference/dashboard/form-components/form-field-wrapper#formfieldwrapperprops'>FormFieldWrapperProps</a>`<TFieldValues, TName>``} />
43
43
 
44
44
  <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/form-field-wrapper.tsx" sourceLine="14" packageName="@vendure/dashboard" since="3.4.0" />
45
45
 
@@ -15,7 +15,7 @@ Parameters
15
15
 
16
16
  ### props
17
17
 
18
- <MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/list-views/data-table#datatableprops'>DataTableProps</a><TData>>`} />
18
+ <MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/list-views/data-table#datatableprops'>DataTableProps</a>`<TData>`>`} />
19
19
 
20
20
  <GenerationInfo sourceFile="packages/dashboard/src/lib/components/data-table/data-table.tsx" sourceLine="113" packageName="@vendure/dashboard" since="3.4.0" />
21
21
 
@@ -99,7 +99,7 @@ Parameters
99
99
 
100
100
  ### props
101
101
 
102
- <MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/list-views/list-page#listpageprops'>ListPageProps</a><T, U, V, AC>>`} />
102
+ <MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/list-views/list-page#listpageprops'>ListPageProps</a>`<T, U, V, AC>`>`} />
103
103
 
104
104
  <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/list-page.tsx" sourceLine="36" packageName="@vendure/dashboard" since="3.3.0" />
105
105
 
@@ -115,7 +115,7 @@ Parameters
115
115
 
116
116
  ### props
117
117
 
118
- <MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/list-views/paginated-list-data-table#paginatedlistdatatableprops'>PaginatedListDataTableProps</a><T, U, V, AC>>`} />
118
+ <MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/list-views/paginated-list-data-table#paginatedlistdatatableprops'>PaginatedListDataTableProps</a>`<T, U, V, AC>`>`} />
119
119
 
120
120
  <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/paginated-list-data-table.tsx" sourceLine="202" packageName="@vendure/dashboard" since="3.4.0" />
121
121
 
@@ -17,7 +17,7 @@ class NativeAuthenticationStrategy implements AuthenticationStrategy<NativeAuthe
17
17
  verifyUserPassword(ctx: RequestContext, userId: ID, password: string) => Promise<boolean>;
18
18
  }
19
19
  ```
20
- * Implements: <DocsLink href="/reference/typescript-api/auth/authentication-strategy#authenticationstrategy">`AuthenticationStrategy`</DocsLink><NativeAuthenticationData>
20
+ * Implements: <DocsLink href="/reference/typescript-api/auth/authentication-strategy#authenticationstrategy">`AuthenticationStrategy`</DocsLink>`<NativeAuthenticationData>`
21
21
 
22
22
 
23
23
 
@@ -131,7 +131,7 @@ Parameters
131
131
 
132
132
  ### config
133
133
 
134
- <MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/cache/self-refreshing-cache#selfrefreshingcacheconfig'>SelfRefreshingCacheConfig</a><V, RefreshArgs>`} />
134
+ <MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/cache/self-refreshing-cache#selfrefreshingcacheconfig'>SelfRefreshingCacheConfig</a>`<V, RefreshArgs>``} />
135
135
 
136
136
  ### refreshArgs
137
137
 
@@ -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
@@ -50,7 +50,7 @@ class CollectionFilter<T extends ConfigArgs = ConfigArgs> extends ConfigurableOp
50
50
  apply(qb: SelectQueryBuilder<ProductVariant>, args: ConfigArg[]) => SelectQueryBuilder<ProductVariant>;
51
51
  }
52
52
  ```
53
- * Extends: <DocsLink href="/reference/typescript-api/configurable-operation-def/#configurableoperationdef">`ConfigurableOperationDef`</DocsLink><T>
53
+ * Extends: <DocsLink href="/reference/typescript-api/configurable-operation-def/#configurableoperationdef">`ConfigurableOperationDef`</DocsLink>`<T>`
54
54
 
55
55
 
56
56
 
@@ -101,7 +101,7 @@ class EntityDuplicator<T extends ConfigArgs = ConfigArgs> extends ConfigurableOp
101
101
  }) => Promise<VendureEntity>;
102
102
  }
103
103
  ```
104
- * Extends: <DocsLink href="/reference/typescript-api/configurable-operation-def/#configurableoperationdef">`ConfigurableOperationDef`</DocsLink><T>
104
+ * Extends: <DocsLink href="/reference/typescript-api/configurable-operation-def/#configurableoperationdef">`ConfigurableOperationDef`</DocsLink>`<T>`
105
105
 
106
106
 
107
107
 
@@ -109,7 +109,7 @@ 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
@@ -143,7 +143,7 @@ interface EntityDuplicatorConfig<T extends ConfigArgs> extends ConfigurableOpera
143
143
  duplicate: DuplicateEntityFn<T>;
144
144
  }
145
145
  ```
146
- * Extends: <DocsLink href="/reference/typescript-api/configurable-operation-def/configurable-operation-def-options#configurableoperationdefoptions">`ConfigurableOperationDefOptions`</DocsLink><T>
146
+ * Extends: <DocsLink href="/reference/typescript-api/configurable-operation-def/configurable-operation-def-options#configurableoperationdefoptions">`ConfigurableOperationDefOptions`</DocsLink>`<T>`
147
147
 
148
148
 
149
149
 
@@ -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
 
@@ -14,7 +14,7 @@ class AutoIncrementIdStrategy implements EntityIdStrategy<'increment'> {
14
14
  encodeId(primaryKey: number) => string;
15
15
  }
16
16
  ```
17
- * Implements: <DocsLink href="/reference/typescript-api/configuration/entity-id-strategy#entityidstrategy">`EntityIdStrategy`</DocsLink><'increment'>
17
+ * Implements: <DocsLink href="/reference/typescript-api/configuration/entity-id-strategy#entityidstrategy">`EntityIdStrategy`</DocsLink>`<'increment'>`
18
18
 
19
19
 
20
20
 
@@ -129,7 +129,7 @@ class UuidIdStrategy implements EntityIdStrategy<'uuid'> {
129
129
  encodeId(primaryKey: string) => string;
130
130
  }
131
131
  ```
132
- * Implements: <DocsLink href="/reference/typescript-api/configuration/entity-id-strategy#entityidstrategy">`EntityIdStrategy`</DocsLink><'uuid'>
132
+ * Implements: <DocsLink href="/reference/typescript-api/configuration/entity-id-strategy#entityidstrategy">`EntityIdStrategy`</DocsLink>`<'uuid'>`
133
133
 
134
134
 
135
135
 
@@ -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.
@@ -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
@@ -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
@@ -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
 
@@ -147,7 +147,7 @@ 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.
@@ -66,7 +66,7 @@ class Promotion extends AdjustmentSource implements ChannelAware, SoftDeletable,
66
66
 
67
67
  ### constructor
68
68
 
69
- <MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>> &#38; { promotionConditions?: Array<<a href='/reference/typescript-api/promotions/promotion-condition#promotioncondition'>PromotionCondition</a><any>>; promotionActions?: Array<<a href='/reference/typescript-api/promotions/promotion-action#promotionaction'>PromotionAction</a><any>>; }) => Promotion`} />
69
+ <MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>> &#38; { promotionConditions?: Array<<a href='/reference/typescript-api/promotions/promotion-condition#promotioncondition'>PromotionCondition</a>`<any>`>; promotionActions?: Array<<a href='/reference/typescript-api/promotions/promotion-action#promotionaction'>PromotionAction</a>`<any>`>; }) => Promotion`} />
70
70
 
71
71
 
72
72
  ### deletedAt