@vendure/docs 0.0.0-202601211543 → 0.0.0-202601211552
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.
- package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +4 -4
- package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +1 -1
- package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx +1 -1
- package/docs/reference/admin-ui-api/routes/register-route-component.mdx +1 -1
- package/docs/reference/admin-ui-api/services/data-service.mdx +3 -3
- package/docs/reference/admin-ui-api/services/modal-service.mdx +2 -2
- package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +13 -13
- package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +2 -2
- package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +1 -1
- package/docs/reference/dashboard/detail-views/detail-page.mdx +1 -1
- package/docs/reference/dashboard/detail-views/use-detail-page.mdx +1 -1
- package/docs/reference/dashboard/detail-views/use-generated-form.mdx +1 -1
- package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
- package/docs/reference/dashboard/list-views/data-table.mdx +1 -1
- package/docs/reference/dashboard/list-views/list-page.mdx +1 -1
- package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +1 -1
- package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +1 -1
- package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +1 -1
- package/docs/reference/typescript-api/configurable-operation-def/index.mdx +1 -1
- package/docs/reference/typescript-api/configuration/collection-filter.mdx +1 -1
- package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +4 -4
- package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +2 -2
- package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
- package/docs/reference/typescript-api/configuration/vendure-config.mdx +1 -1
- package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
- package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
- package/docs/reference/typescript-api/data-access/list-query-builder.mdx +1 -1
- package/docs/reference/typescript-api/data-access/transactional-connection.mdx +1 -1
- package/docs/reference/typescript-api/entities/promotion.mdx +1 -1
- package/docs/reference/typescript-api/events/event-bus.mdx +1 -1
- package/docs/reference/typescript-api/events/event-types.mdx +29 -29
- package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +5 -5
- package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +4 -4
- package/docs/reference/typescript-api/import-export/import-parser.mdx +1 -1
- package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/index.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +1 -1
- package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/job.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/types.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-process.mdx +4 -4
- package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +6 -6
- package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +4 -4
- package/docs/reference/typescript-api/payment/payment-method-handler.mdx +2 -2
- package/docs/reference/typescript-api/payment/payment-options.mdx +3 -3
- package/docs/reference/typescript-api/payment/payment-process.mdx +4 -4
- package/docs/reference/typescript-api/payment/refund-process.mdx +4 -4
- package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
- package/docs/reference/typescript-api/promotions/promotion-action.mdx +21 -21
- package/docs/reference/typescript-api/promotions/promotion-condition.mdx +4 -4
- package/docs/reference/typescript-api/promotions/promotion-options.mdx +2 -2
- package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +3 -3
- package/docs/reference/typescript-api/services/administrator-service.mdx +1 -1
- package/docs/reference/typescript-api/services/asset-service.mdx +1 -1
- package/docs/reference/typescript-api/services/channel-service.mdx +3 -3
- package/docs/reference/typescript-api/services/collection-service.mdx +2 -2
- package/docs/reference/typescript-api/services/country-service.mdx +1 -1
- package/docs/reference/typescript-api/services/customer-group-service.mdx +2 -2
- package/docs/reference/typescript-api/services/customer-service.mdx +5 -5
- package/docs/reference/typescript-api/services/facet-service.mdx +2 -2
- package/docs/reference/typescript-api/services/facet-value-service.mdx +2 -2
- package/docs/reference/typescript-api/services/history-service.mdx +2 -2
- package/docs/reference/typescript-api/services/order-service.mdx +18 -18
- package/docs/reference/typescript-api/services/payment-method-service.mdx +1 -1
- package/docs/reference/typescript-api/services/product-option-service.mdx +1 -1
- package/docs/reference/typescript-api/services/product-service.mdx +2 -2
- package/docs/reference/typescript-api/services/product-variant-service.mdx +3 -3
- package/docs/reference/typescript-api/services/promotion-service.mdx +3 -3
- package/docs/reference/typescript-api/services/province-service.mdx +1 -1
- package/docs/reference/typescript-api/services/role-service.mdx +1 -1
- package/docs/reference/typescript-api/services/seller-service.mdx +1 -1
- package/docs/reference/typescript-api/services/settings-store-service.mdx +6 -6
- package/docs/reference/typescript-api/services/shipping-method-service.mdx +1 -1
- package/docs/reference/typescript-api/services/stock-location-service.mdx +1 -1
- package/docs/reference/typescript-api/services/stock-movement-service.mdx +1 -1
- package/docs/reference/typescript-api/services/tag-service.mdx +1 -1
- package/docs/reference/typescript-api/services/tax-category-service.mdx +1 -1
- package/docs/reference/typescript-api/services/tax-rate-service.mdx +1 -1
- package/docs/reference/typescript-api/services/user-service.mdx +1 -1
- package/docs/reference/typescript-api/services/zone-service.mdx +1 -1
- package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +1 -1
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +3 -3
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-options.mdx +5 -5
- package/docs/reference/typescript-api/state-machine/fsm.mdx +1 -1
- package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +4 -4
- package/docs/reference/typescript-api/testing/register-initializer.mdx +1 -1
- package/package.json +1 -1
|
@@ -93,18 +93,18 @@ according to the field's scope configuration.
|
|
|
93
93
|
|
|
94
94
|
### getMany
|
|
95
95
|
|
|
96
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, keys: string[]) => Promise<Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a
|
|
96
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, keys: string[]) => Promise<Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a>`<any>`>>`} />
|
|
97
97
|
|
|
98
98
|
Get multiple values efficiently. Each key is scoped according to
|
|
99
99
|
its individual field configuration.
|
|
100
100
|
### getMany
|
|
101
101
|
|
|
102
|
-
<MemberInfo kind="method" type={`(keys: string[], ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a
|
|
102
|
+
<MemberInfo kind="method" type={`(keys: string[], ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a>`<any>`>>`} />
|
|
103
103
|
|
|
104
104
|
|
|
105
105
|
### getMany
|
|
106
106
|
|
|
107
|
-
<MemberInfo kind="method" type={`(keysOrCtx: string[] | <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, ctxOrKeys: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | string[]) => Promise<Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a
|
|
107
|
+
<MemberInfo kind="method" type={`(keysOrCtx: string[] | <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, ctxOrKeys: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | string[]) => Promise<Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a>`<any>`>>`} />
|
|
108
108
|
|
|
109
109
|
|
|
110
110
|
### set
|
|
@@ -126,19 +126,19 @@ of the operation instead of throwing errors.
|
|
|
126
126
|
|
|
127
127
|
### setMany
|
|
128
128
|
|
|
129
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, values: Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a
|
|
129
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, values: Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a>`<any>`>) => Promise<<a href='/reference/typescript-api/settings-store/set-settings-store-value-result#setsettingsstorevalueresult'>SetSettingsStoreValueResult</a>[]>`} />
|
|
130
130
|
|
|
131
131
|
Set multiple values with structured result feedback for each operation.
|
|
132
132
|
This method will not throw errors but will return
|
|
133
133
|
detailed results for each key-value pair.
|
|
134
134
|
### setMany
|
|
135
135
|
|
|
136
|
-
<MemberInfo kind="method" type={`(values: Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a
|
|
136
|
+
<MemberInfo kind="method" type={`(values: Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a>`<any>`>, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<<a href='/reference/typescript-api/settings-store/set-settings-store-value-result#setsettingsstorevalueresult'>SetSettingsStoreValueResult</a>[]>`} />
|
|
137
137
|
|
|
138
138
|
|
|
139
139
|
### setMany
|
|
140
140
|
|
|
141
|
-
<MemberInfo kind="method" type={`(valuesOrCtx: Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a
|
|
141
|
+
<MemberInfo kind="method" type={`(valuesOrCtx: Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a>`<any>`> | <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, ctxOrValues: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a>`<any>`>) => Promise<<a href='/reference/typescript-api/settings-store/set-settings-store-value-result#setsettingsstorevalueresult'>SetSettingsStoreValueResult</a>[]>`} />
|
|
142
142
|
|
|
143
143
|
|
|
144
144
|
### getFieldDefinition
|
|
@@ -32,7 +32,7 @@ class ShippingMethodService {
|
|
|
32
32
|
|
|
33
33
|
### findAll
|
|
34
34
|
|
|
35
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>>, relations: RelationPaths<<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>> = []) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
35
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>>, relations: RelationPaths<<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>> = []) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<Translated<<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>`ShippingMethod</a>>>>`} />
|
|
36
36
|
|
|
37
37
|
|
|
38
38
|
### findOne
|
|
@@ -44,7 +44,7 @@ class StockLocationService {
|
|
|
44
44
|
|
|
45
45
|
### findAll
|
|
46
46
|
|
|
47
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
47
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<<a href='/reference/typescript-api/entities/stock-location#stocklocation'>`StockLocation</a>>>`} />
|
|
48
48
|
|
|
49
49
|
|
|
50
50
|
### create
|
|
@@ -40,7 +40,7 @@ class StockMovementService {
|
|
|
40
40
|
|
|
41
41
|
### getStockMovementsByProductVariantId
|
|
42
42
|
|
|
43
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, options?: StockMovementListOptions) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
43
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, options?: StockMovementListOptions) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<<a href='/reference/typescript-api/entities/stock-movement#stockmovement'>`StockMovement</a>>>`} />
|
|
44
44
|
|
|
45
45
|
Returns a <DocsLink href="/reference/typescript-api/common/paginated-list#paginatedlist">PaginatedList</DocsLink> of all StockMovements associated with the specified ProductVariant.
|
|
46
46
|
### adjustProductVariantStock
|
|
@@ -28,7 +28,7 @@ class TagService {
|
|
|
28
28
|
|
|
29
29
|
### findAll
|
|
30
30
|
|
|
31
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/tag#tag'>Tag</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
31
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/tag#tag'>Tag</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<<a href='/reference/typescript-api/entities/tag#tag'>`Tag</a>>>`} />
|
|
32
32
|
|
|
33
33
|
|
|
34
34
|
### findOne
|
|
@@ -26,7 +26,7 @@ class TaxCategoryService {
|
|
|
26
26
|
|
|
27
27
|
### findAll
|
|
28
28
|
|
|
29
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/tax-category#taxcategory'>TaxCategory</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
29
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/tax-category#taxcategory'>TaxCategory</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<<a href='/reference/typescript-api/entities/tax-category#taxcategory'>`TaxCategory</a>>>`} />
|
|
30
30
|
|
|
31
31
|
|
|
32
32
|
### findOne
|
|
@@ -27,7 +27,7 @@ class TaxRateService {
|
|
|
27
27
|
|
|
28
28
|
### findAll
|
|
29
29
|
|
|
30
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a>>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
30
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a>>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<<a href='/reference/typescript-api/entities/tax-rate#taxrate'>`TaxRate</a>>>`} />
|
|
31
31
|
|
|
32
32
|
|
|
33
33
|
### findOne
|
|
@@ -79,7 +79,7 @@ Sets the <DocsLink href="/reference/typescript-api/entities/authentication-metho
|
|
|
79
79
|
flow.
|
|
80
80
|
### verifyUserByToken
|
|
81
81
|
|
|
82
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, verificationToken: string, password?: string) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a
|
|
82
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, verificationToken: string, password?: string) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>`<VerifyCustomerAccountResult, <a href='/reference/typescript-api/entities/user#user'>`User</a>>>`} />
|
|
83
83
|
|
|
84
84
|
Verifies a verificationToken by looking for a User which has previously had it set using the
|
|
85
85
|
`setVerificationToken()` method, and checks that the token is valid and has not expired.
|
|
@@ -29,7 +29,7 @@ class ZoneService {
|
|
|
29
29
|
|
|
30
30
|
### findAll
|
|
31
31
|
|
|
32
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/zone#zone'>Zone</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
32
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/zone#zone'>Zone</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<<a href='/reference/typescript-api/entities/zone#zone'>`Zone</a>>>`} />
|
|
33
33
|
|
|
34
34
|
|
|
35
35
|
### findOne
|
|
@@ -37,7 +37,7 @@ class ShippingCalculator<T extends ConfigArgs = ConfigArgs> extends Configurable
|
|
|
37
37
|
constructor(config: ShippingCalculatorConfig<T>)
|
|
38
38
|
}
|
|
39
39
|
```
|
|
40
|
-
* Extends: <DocsLink href="/reference/typescript-api/configurable-operation-def/#configurableoperationdef">`ConfigurableOperationDef`</DocsLink
|
|
40
|
+
* Extends: <DocsLink href="/reference/typescript-api/configurable-operation-def/#configurableoperationdef">`ConfigurableOperationDef`</DocsLink>`<T>`
|
|
41
41
|
|
|
42
42
|
|
|
43
43
|
|
|
@@ -13,7 +13,7 @@ interface ShippingEligibilityCheckerConfig<T extends ConfigArgs> extends Configu
|
|
|
13
13
|
shouldRunCheck?: ShouldRunCheckFn<T>;
|
|
14
14
|
}
|
|
15
15
|
```
|
|
16
|
-
* Extends: <DocsLink href="/reference/typescript-api/configurable-operation-def/configurable-operation-def-options#configurableoperationdefoptions">`ConfigurableOperationDefOptions`</DocsLink
|
|
16
|
+
* Extends: <DocsLink href="/reference/typescript-api/configurable-operation-def/configurable-operation-def-options#configurableoperationdefoptions">`ConfigurableOperationDefOptions`</DocsLink>`<T>`
|
|
17
17
|
|
|
18
18
|
|
|
19
19
|
|
|
@@ -21,12 +21,12 @@ interface ShippingEligibilityCheckerConfig<T extends ConfigArgs> extends Configu
|
|
|
21
21
|
|
|
22
22
|
### check
|
|
23
23
|
|
|
24
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/shipping/check-shipping-eligibility-checker-fn#checkshippingeligibilitycheckerfn'>CheckShippingEligibilityCheckerFn</a
|
|
24
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/shipping/check-shipping-eligibility-checker-fn#checkshippingeligibilitycheckerfn'>CheckShippingEligibilityCheckerFn</a>`<T>``} />
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
### shouldRunCheck
|
|
28
28
|
|
|
29
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/shipping/should-run-check-fn#shouldruncheckfn'>ShouldRunCheckFn</a
|
|
29
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/shipping/should-run-check-fn#shouldruncheckfn'>ShouldRunCheckFn</a>`<T>``} />
|
|
30
30
|
|
|
31
31
|
|
|
32
32
|
|
|
@@ -29,7 +29,7 @@ class ShippingEligibilityChecker<T extends ConfigArgs = ConfigArgs> extends Conf
|
|
|
29
29
|
toJSON() => ;
|
|
30
30
|
}
|
|
31
31
|
```
|
|
32
|
-
* Extends: <DocsLink href="/reference/typescript-api/configurable-operation-def/#configurableoperationdef">`ConfigurableOperationDef`</DocsLink
|
|
32
|
+
* Extends: <DocsLink href="/reference/typescript-api/configurable-operation-def/#configurableoperationdef">`ConfigurableOperationDef`</DocsLink>`<T>`
|
|
33
33
|
|
|
34
34
|
|
|
35
35
|
|
|
@@ -37,7 +37,7 @@ class ShippingEligibilityChecker<T extends ConfigArgs = ConfigArgs> extends Conf
|
|
|
37
37
|
|
|
38
38
|
### constructor
|
|
39
39
|
|
|
40
|
-
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/shipping/shipping-eligibility-checker-config#shippingeligibilitycheckerconfig'>ShippingEligibilityCheckerConfig</a
|
|
40
|
+
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/shipping/shipping-eligibility-checker-config#shippingeligibilitycheckerconfig'>ShippingEligibilityCheckerConfig</a>`<T>`) => ShippingEligibilityChecker`} />
|
|
41
41
|
|
|
42
42
|
|
|
43
43
|
### init
|
|
@@ -21,12 +21,12 @@ interface ShippingOptions {
|
|
|
21
21
|
|
|
22
22
|
### shippingEligibilityCheckers
|
|
23
23
|
|
|
24
|
-
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/shipping/shipping-eligibility-checker#shippingeligibilitychecker'>ShippingEligibilityChecker</a
|
|
24
|
+
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/shipping/shipping-eligibility-checker#shippingeligibilitychecker'>ShippingEligibilityChecker</a>`<any>`>`} />
|
|
25
25
|
|
|
26
26
|
An array of available ShippingEligibilityCheckers for use in configuring ShippingMethods
|
|
27
27
|
### shippingCalculators
|
|
28
28
|
|
|
29
|
-
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/shipping/shipping-calculator#shippingcalculator'>ShippingCalculator</a
|
|
29
|
+
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/shipping/shipping-calculator#shippingcalculator'>ShippingCalculator</a>`<any>`>`} />
|
|
30
30
|
|
|
31
31
|
An array of available ShippingCalculators for use in configuring ShippingMethods
|
|
32
32
|
### shippingLineAssignmentStrategy
|
|
@@ -38,19 +38,19 @@ This allows you to set multiple shipping methods for a single order, each assign
|
|
|
38
38
|
OrderLines.
|
|
39
39
|
### customFulfillmentProcess
|
|
40
40
|
|
|
41
|
-
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess'>FulfillmentProcess</a
|
|
41
|
+
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess'>FulfillmentProcess</a>`<any>`>`} />
|
|
42
42
|
|
|
43
43
|
Allows the definition of custom states and transition logic for the fulfillment process state machine.
|
|
44
44
|
Takes an array of objects implementing the <DocsLink href="/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess">FulfillmentProcess</DocsLink> interface.
|
|
45
45
|
### process
|
|
46
46
|
|
|
47
|
-
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess'>FulfillmentProcess</a
|
|
47
|
+
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess'>FulfillmentProcess</a>`<any>`>`} default={`<a href='/reference/typescript-api/fulfillment/fulfillment-process#defaultfulfillmentprocess'>defaultFulfillmentProcess</a>`} since="2.0.0" />
|
|
48
48
|
|
|
49
49
|
Allows the definition of custom states and transition logic for the fulfillment process state machine.
|
|
50
50
|
Takes an array of objects implementing the <DocsLink href="/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess">FulfillmentProcess</DocsLink> interface.
|
|
51
51
|
### fulfillmentHandlers
|
|
52
52
|
|
|
53
|
-
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/fulfillment/fulfillment-handler#fulfillmenthandler'>FulfillmentHandler</a
|
|
53
|
+
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/fulfillment/fulfillment-handler#fulfillmenthandler'>FulfillmentHandler</a>`<any>`>`} />
|
|
54
54
|
|
|
55
55
|
An array of available FulfillmentHandlers.
|
|
56
56
|
|
|
@@ -23,7 +23,7 @@ class FSM<T extends string, Data = any> {
|
|
|
23
23
|
|
|
24
24
|
### constructor
|
|
25
25
|
|
|
26
|
-
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/state-machine/state-machine-config#statemachineconfig'>StateMachineConfig</a
|
|
26
|
+
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/state-machine/state-machine-config#statemachineconfig'>StateMachineConfig</a>`<T, Data>`, initialState: T) => FSM`} />
|
|
27
27
|
|
|
28
28
|
|
|
29
29
|
### initialState
|
|
@@ -19,13 +19,13 @@ interface StateMachineConfig<T extends string, Data = undefined> {
|
|
|
19
19
|
|
|
20
20
|
### transitions
|
|
21
21
|
|
|
22
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a
|
|
22
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<T>``} />
|
|
23
23
|
|
|
24
24
|
Defines the available states of the state machine as well as the permitted
|
|
25
25
|
transitions from one state to another.
|
|
26
26
|
### onTransitionStart
|
|
27
27
|
|
|
28
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a
|
|
28
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a>`<T, Data>``} />
|
|
29
29
|
|
|
30
30
|
Called before a transition takes place. If the function resolves to `false` or a string, then the transition
|
|
31
31
|
will be cancelled. In the case of a string, the string (error message) will be forwarded to the onError handler.
|
|
@@ -34,12 +34,12 @@ If this function returns a value resolving to `true` or `void` (no return value)
|
|
|
34
34
|
will be permitted.
|
|
35
35
|
### onTransitionEnd
|
|
36
36
|
|
|
37
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a
|
|
37
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a>`<T, Data>``} />
|
|
38
38
|
|
|
39
39
|
Called after a transition has taken place.
|
|
40
40
|
### onError
|
|
41
41
|
|
|
42
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a
|
|
42
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a>`<T>``} />
|
|
43
43
|
|
|
44
44
|
Called when a transition is prevented and the `onTransitionStart` handler has returned an
|
|
45
45
|
error message.
|
|
@@ -18,5 +18,5 @@ Parameters
|
|
|
18
18
|
|
|
19
19
|
### initializer
|
|
20
20
|
|
|
21
|
-
<MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/testing/test-db-initializer#testdbinitializer'>TestDbInitializer</a
|
|
21
|
+
<MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/testing/test-db-initializer#testdbinitializer'>TestDbInitializer</a>`<any>``} />
|
|
22
22
|
|