@vendure/docs 0.0.0-202601211552 → 0.0.0-202601220950
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +3 -3
- package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.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 +1 -1
- 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 +1 -1
- 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/graphql-api/admin/_index.mdx +11 -0
- package/docs/reference/graphql-api/shop/_index.mdx +11 -0
- 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/entity-duplicator.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/fulfillment/fulfillment-handler.mdx +3 -3
- 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 +2 -2
- 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 +5 -5
- package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +2 -2
- package/docs/reference/typescript-api/payment/payment-method-handler.mdx +1 -1
- 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 +11 -11
- package/docs/reference/typescript-api/promotions/promotion-condition.mdx +2 -2
- package/docs/reference/typescript-api/promotions/promotion-options.mdx +2 -2
- package/docs/reference/typescript-api/request/request-context.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-eligibility-checker-config.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +1 -1
- 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 +6 -3
|
@@ -67,7 +67,7 @@ class InMemoryJobQueueStrategy extends PollingJobQueueStrategy implements Inspec
|
|
|
67
67
|
|
|
68
68
|
### add
|
|
69
69
|
|
|
70
|
-
<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a
|
|
70
|
+
<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>) => Promise<<a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>>`} />
|
|
71
71
|
|
|
72
72
|
|
|
73
73
|
### findOne
|
|
@@ -77,7 +77,7 @@ class InMemoryJobQueueStrategy extends PollingJobQueueStrategy implements Inspec
|
|
|
77
77
|
|
|
78
78
|
### findMany
|
|
79
79
|
|
|
80
|
-
<MemberInfo kind="method" type={`(options?: JobListOptions) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
80
|
+
<MemberInfo kind="method" type={`(options?: JobListOptions) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><<a href='/reference/typescript-api/job-queue/job#job'>Job</a>>>`} />
|
|
81
81
|
|
|
82
82
|
|
|
83
83
|
### findManyById
|
|
@@ -35,12 +35,12 @@ class JobQueue<Data extends JobData<Data> = object> {
|
|
|
35
35
|
|
|
36
36
|
### constructor
|
|
37
37
|
|
|
38
|
-
<MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/job-queue/types#createqueueoptions'>CreateQueueOptions</a
|
|
38
|
+
<MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/job-queue/types#createqueueoptions'>CreateQueueOptions</a><Data>, jobQueueStrategy: <a href='/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy'>JobQueueStrategy</a>, jobBufferService: JobBufferService) => JobQueue`} />
|
|
39
39
|
|
|
40
40
|
|
|
41
41
|
### add
|
|
42
42
|
|
|
43
|
-
<MemberInfo kind="method" type={`(data: Data, options?: JobOptions<Data>) => Promise<<a href='/reference/typescript-api/job-queue/subscribable-job#subscribablejob'>SubscribableJob</a
|
|
43
|
+
<MemberInfo kind="method" type={`(data: Data, options?: JobOptions<Data>) => Promise<<a href='/reference/typescript-api/job-queue/subscribable-job#subscribablejob'>SubscribableJob</a><Data>>`} />
|
|
44
44
|
|
|
45
45
|
Adds a new <DocsLink href="/reference/typescript-api/job-queue/job#job">Job</DocsLink> to the queue. The resolved <DocsLink href="/reference/typescript-api/job-queue/subscribable-job#subscribablejob">SubscribableJob</DocsLink> allows the
|
|
46
46
|
calling code to subscribe to updates to the Job:
|
|
@@ -28,7 +28,7 @@ interface InspectableJobQueueStrategy extends JobQueueStrategy {
|
|
|
28
28
|
Returns a job by its id.
|
|
29
29
|
### findMany
|
|
30
30
|
|
|
31
|
-
<MemberInfo kind="method" type={`(options?: JobListOptions) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
31
|
+
<MemberInfo kind="method" type={`(options?: JobListOptions) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><<a href='/reference/typescript-api/job-queue/job#job'>Job</a>>>`} />
|
|
32
32
|
|
|
33
33
|
Returns a list of jobs according to the specified options.
|
|
34
34
|
### findManyById
|
|
@@ -97,14 +97,14 @@ interface JobBuffer<Data extends JobData<Data> = object> {
|
|
|
97
97
|
|
|
98
98
|
### collect
|
|
99
99
|
|
|
100
|
-
<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a
|
|
100
|
+
<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>) => boolean | Promise<boolean>`} />
|
|
101
101
|
|
|
102
102
|
This method is called whenever a job is added to the job queue. If it returns `true`, then
|
|
103
103
|
the job will be _buffered_ and _not_ added to the job queue. If it returns `false`, the job
|
|
104
104
|
will be added to the job queue as normal.
|
|
105
105
|
### reduce
|
|
106
106
|
|
|
107
|
-
<MemberInfo kind="method" type={`(collectedJobs: Array<<a href='/reference/typescript-api/job-queue/job#job'>Job</a
|
|
107
|
+
<MemberInfo kind="method" type={`(collectedJobs: Array<<a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>>) => Array<<a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>> | Promise<Array<<a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>>>`} />
|
|
108
108
|
|
|
109
109
|
This method is called whenever the buffer gets flushed via a call to `JobQueueService.flush()`.
|
|
110
110
|
It allows logic to be run on the buffered jobs which enables optimizations such as
|
|
@@ -61,7 +61,7 @@ class JobQueueService implements OnModuleDestroy {
|
|
|
61
61
|
|
|
62
62
|
### createQueue
|
|
63
63
|
|
|
64
|
-
<MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/job-queue/types#createqueueoptions'>CreateQueueOptions</a
|
|
64
|
+
<MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/job-queue/types#createqueueoptions'>CreateQueueOptions</a><Data>) => Promise<<a href='/reference/typescript-api/job-queue/#jobqueue'>JobQueue</a><Data>>`} />
|
|
65
65
|
|
|
66
66
|
Configures and creates a new <DocsLink href="/reference/typescript-api/job-queue/#jobqueue">JobQueue</DocsLink> instance.
|
|
67
67
|
### start
|
|
@@ -71,19 +71,19 @@ Configures and creates a new <DocsLink href="/reference/typescript-api/job-queue
|
|
|
71
71
|
|
|
72
72
|
### addBuffer
|
|
73
73
|
|
|
74
|
-
<MemberInfo kind="method" type={`(buffer: <a href='/reference/typescript-api/job-queue/job-buffer#jobbuffer'>JobBuffer</a
|
|
74
|
+
<MemberInfo kind="method" type={`(buffer: <a href='/reference/typescript-api/job-queue/job-buffer#jobbuffer'>JobBuffer</a><any>) => `} since="1.3.0" />
|
|
75
75
|
|
|
76
76
|
Adds a <DocsLink href="/reference/typescript-api/job-queue/job-buffer#jobbuffer">JobBuffer</DocsLink>, which will make it active and begin collecting
|
|
77
77
|
jobs to buffer.
|
|
78
78
|
### removeBuffer
|
|
79
79
|
|
|
80
|
-
<MemberInfo kind="method" type={`(buffer: <a href='/reference/typescript-api/job-queue/job-buffer#jobbuffer'>JobBuffer</a
|
|
80
|
+
<MemberInfo kind="method" type={`(buffer: <a href='/reference/typescript-api/job-queue/job-buffer#jobbuffer'>JobBuffer</a><any>) => `} since="1.3.0" />
|
|
81
81
|
|
|
82
82
|
Removes a <DocsLink href="/reference/typescript-api/job-queue/job-buffer#jobbuffer">JobBuffer</DocsLink>, prevent it from collecting and buffering any
|
|
83
83
|
subsequent jobs.
|
|
84
84
|
### bufferSize
|
|
85
85
|
|
|
86
|
-
<MemberInfo kind="method" type={`(forBuffers: Array<<a href='/reference/typescript-api/job-queue/job-buffer#jobbuffer'>JobBuffer</a
|
|
86
|
+
<MemberInfo kind="method" type={`(forBuffers: Array<<a href='/reference/typescript-api/job-queue/job-buffer#jobbuffer'>JobBuffer</a><any> | string>) => Promise<{ [bufferId: string]: number }>`} since="1.3.0" />
|
|
87
87
|
|
|
88
88
|
Returns an object containing the number of buffered jobs arranged by bufferId. This
|
|
89
89
|
can be used to decide whether a particular buffer has any jobs to flush.
|
|
@@ -100,7 +100,7 @@ const sizes = await this.jobQueueService.bufferSize('buffer-1', 'buffer-2');
|
|
|
100
100
|
```
|
|
101
101
|
### flush
|
|
102
102
|
|
|
103
|
-
<MemberInfo kind="method" type={`(forBuffers: Array<<a href='/reference/typescript-api/job-queue/job-buffer#jobbuffer'>JobBuffer</a
|
|
103
|
+
<MemberInfo kind="method" type={`(forBuffers: Array<<a href='/reference/typescript-api/job-queue/job-buffer#jobbuffer'>JobBuffer</a><any> | string>) => Promise<<a href='/reference/typescript-api/job-queue/job#job'>Job</a>[]>`} since="1.3.0" />
|
|
104
104
|
|
|
105
105
|
Flushes the specified buffers, which means that the buffer is cleared and the jobs get
|
|
106
106
|
sent to the job queue for processing. Before sending the jobs to the job queue,
|
|
@@ -36,17 +36,17 @@ interface JobQueueStrategy extends InjectableStrategy {
|
|
|
36
36
|
|
|
37
37
|
### add
|
|
38
38
|
|
|
39
|
-
<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a
|
|
39
|
+
<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>, jobOptions?: JobQueueStrategyJobOptions<Data>) => Promise<<a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>>`} />
|
|
40
40
|
|
|
41
41
|
Add a new job to the queue.
|
|
42
42
|
### start
|
|
43
43
|
|
|
44
|
-
<MemberInfo kind="method" type={`(queueName: string, process: (job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a
|
|
44
|
+
<MemberInfo kind="method" type={`(queueName: string, process: (job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>) => Promise<any>) => Promise<void>`} />
|
|
45
45
|
|
|
46
46
|
Start the job queue
|
|
47
47
|
### stop
|
|
48
48
|
|
|
49
|
-
<MemberInfo kind="method" type={`(queueName: string, process: (job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a
|
|
49
|
+
<MemberInfo kind="method" type={`(queueName: string, process: (job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>) => Promise<any>) => Promise<void>`} />
|
|
50
50
|
|
|
51
51
|
Stops a queue from running. Its not guaranteed to stop immediately.
|
|
52
52
|
|
|
@@ -117,7 +117,7 @@ class Job<T extends JobData<T> = any> {
|
|
|
117
117
|
|
|
118
118
|
### constructor
|
|
119
119
|
|
|
120
|
-
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/job-queue/types#jobconfig'>JobConfig</a
|
|
120
|
+
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/job-queue/types#jobconfig'>JobConfig</a><T>) => Job`} />
|
|
121
121
|
|
|
122
122
|
|
|
123
123
|
### start
|
|
@@ -155,12 +155,12 @@ Sets a RUNNING job back to PENDING. Should be used when the JobQueue is being
|
|
|
155
155
|
destroyed before the job has been completed.
|
|
156
156
|
### on
|
|
157
157
|
|
|
158
|
-
<MemberInfo kind="method" type={`(eventType: <a href='/reference/typescript-api/job-queue/job#jobeventtype'>JobEventType</a>, listener: <a href='/reference/typescript-api/job-queue/job#jobeventlistener'>JobEventListener</a
|
|
158
|
+
<MemberInfo kind="method" type={`(eventType: <a href='/reference/typescript-api/job-queue/job#jobeventtype'>JobEventType</a>, listener: <a href='/reference/typescript-api/job-queue/job#jobeventlistener'>JobEventListener</a><T>) => `} />
|
|
159
159
|
|
|
160
160
|
Used to register event handler for job events
|
|
161
161
|
### off
|
|
162
162
|
|
|
163
|
-
<MemberInfo kind="method" type={`(eventType: <a href='/reference/typescript-api/job-queue/job#jobeventtype'>JobEventType</a>, listener: <a href='/reference/typescript-api/job-queue/job#jobeventlistener'>JobEventListener</a
|
|
163
|
+
<MemberInfo kind="method" type={`(eventType: <a href='/reference/typescript-api/job-queue/job#jobeventtype'>JobEventType</a>, listener: <a href='/reference/typescript-api/job-queue/job#jobeventlistener'>JobEventListener</a><T>) => `} />
|
|
164
164
|
|
|
165
165
|
|
|
166
166
|
|
|
@@ -82,12 +82,12 @@ class PollingJobQueueStrategy extends InjectableJobQueueStrategy {
|
|
|
82
82
|
|
|
83
83
|
### start
|
|
84
84
|
|
|
85
|
-
<MemberInfo kind="method" type={`(queueName: string, process: (job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a
|
|
85
|
+
<MemberInfo kind="method" type={`(queueName: string, process: (job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>) => Promise<any>) => `} />
|
|
86
86
|
|
|
87
87
|
|
|
88
88
|
### stop
|
|
89
89
|
|
|
90
|
-
<MemberInfo kind="method" type={`(queueName: string, process: (job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a
|
|
90
|
+
<MemberInfo kind="method" type={`(queueName: string, process: (job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>) => Promise<any>) => `} />
|
|
91
91
|
|
|
92
92
|
|
|
93
93
|
### cancelJob
|
|
@@ -41,7 +41,7 @@ class SqlJobQueueStrategy extends PollingJobQueueStrategy implements Inspectable
|
|
|
41
41
|
|
|
42
42
|
### add
|
|
43
43
|
|
|
44
|
-
<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a
|
|
44
|
+
<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>, jobOptions?: JobQueueStrategyJobOptions<Data>) => Promise<<a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>>`} />
|
|
45
45
|
|
|
46
46
|
|
|
47
47
|
### next
|
|
@@ -51,12 +51,12 @@ class SqlJobQueueStrategy extends PollingJobQueueStrategy implements Inspectable
|
|
|
51
51
|
|
|
52
52
|
### update
|
|
53
53
|
|
|
54
|
-
<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a
|
|
54
|
+
<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a><any>) => Promise<void>`} />
|
|
55
55
|
|
|
56
56
|
|
|
57
57
|
### findMany
|
|
58
58
|
|
|
59
|
-
<MemberInfo kind="method" type={`(options?: JobListOptions) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
59
|
+
<MemberInfo kind="method" type={`(options?: JobListOptions) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><<a href='/reference/typescript-api/job-queue/job#job'>Job</a>>>`} />
|
|
60
60
|
|
|
61
61
|
|
|
62
62
|
### findOne
|
|
@@ -23,12 +23,12 @@ class SubscribableJob<T extends JobData<T> = any> extends Job<T> {
|
|
|
23
23
|
|
|
24
24
|
### constructor
|
|
25
25
|
|
|
26
|
-
<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a
|
|
26
|
+
<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a><T>, jobQueueStrategy: <a href='/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy'>JobQueueStrategy</a>) => SubscribableJob`} />
|
|
27
27
|
|
|
28
28
|
|
|
29
29
|
### updates
|
|
30
30
|
|
|
31
|
-
<MemberInfo kind="method" type={`(options?: <a href='/reference/typescript-api/job-queue/types#jobupdateoptions'>JobUpdateOptions</a>) => Observable<<a href='/reference/typescript-api/job-queue/types#jobupdate'>JobUpdate</a
|
|
31
|
+
<MemberInfo kind="method" type={`(options?: <a href='/reference/typescript-api/job-queue/types#jobupdateoptions'>JobUpdateOptions</a>) => Observable<<a href='/reference/typescript-api/job-queue/types#jobupdate'>JobUpdate</a><T>>`} />
|
|
32
32
|
|
|
33
33
|
Returns an Observable stream of updates to the Job. Works by polling the current JobQueueStrategy's `findOne()` method
|
|
34
34
|
to obtain updates. If the updates are not subscribed to, then no polling occurs.
|
|
@@ -72,7 +72,7 @@ interface CreateQueueOptions<T extends JobData<T>> {
|
|
|
72
72
|
The name of the queue, e.g. "image processing", "re-indexing" etc.
|
|
73
73
|
### process
|
|
74
74
|
|
|
75
|
-
<MemberInfo kind="property" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a
|
|
75
|
+
<MemberInfo kind="property" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a><T>) => Promise<any>`} />
|
|
76
76
|
|
|
77
77
|
Defines the work to be done for each job in the queue. The returned promise
|
|
78
78
|
should resolve when the job is complete, or be rejected in case of an error.
|
|
@@ -48,7 +48,7 @@ class DefaultGuestCheckoutStrategy implements GuestCheckoutStrategy {
|
|
|
48
48
|
|
|
49
49
|
### setCustomerForOrder
|
|
50
50
|
|
|
51
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, input: CreateCustomerInput) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a
|
|
51
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, input: CreateCustomerInput) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><SetCustomerForOrderResult, <a href='/reference/typescript-api/entities/customer#customer'>Customer</a>>>`} />
|
|
52
52
|
|
|
53
53
|
|
|
54
54
|
|
|
@@ -42,7 +42,7 @@ interface GuestCheckoutStrategy extends InjectableStrategy {
|
|
|
42
42
|
|
|
43
43
|
### setCustomerForOrder
|
|
44
44
|
|
|
45
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, input: CreateCustomerInput) => | <a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a
|
|
45
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, input: CreateCustomerInput) => | <a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><SetCustomerForOrderResult, <a href='/reference/typescript-api/entities/customer#customer'>Customer</a>> | Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><SetCustomerForOrderResult, <a href='/reference/typescript-api/entities/customer#customer'>Customer</a>>>`} />
|
|
46
46
|
|
|
47
47
|
This method is called when the `setCustomerForOrder` mutation is executed.
|
|
48
48
|
It should return either a Customer object or an ErrorResult.
|
|
@@ -57,7 +57,7 @@ Defines the logic used to calculate the unit price of an OrderLine when adding a
|
|
|
57
57
|
item to an Order.
|
|
58
58
|
### process
|
|
59
59
|
|
|
60
|
-
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/orders/order-process#orderprocess'>OrderProcess</a
|
|
60
|
+
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/orders/order-process#orderprocess'>OrderProcess</a><any>>`} default={`[]`} />
|
|
61
61
|
|
|
62
62
|
Allows the definition of custom states and transition logic for the order process state machine.
|
|
63
63
|
Takes an array of objects implementing the <DocsLink href="/reference/typescript-api/orders/order-process#orderprocess">OrderProcess</DocsLink> interface.
|
|
@@ -113,7 +113,7 @@ will be reflected in the GraphQL `OrderLine.unitPrice[WithTax]ChangeSinceAdded`
|
|
|
113
113
|
Defines the point of the order process at which the Order is set as "placed".
|
|
114
114
|
### activeOrderStrategy
|
|
115
115
|
|
|
116
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/orders/active-order-strategy#activeorderstrategy'>ActiveOrderStrategy</a
|
|
116
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/orders/active-order-strategy#activeorderstrategy'>ActiveOrderStrategy</a><any> | Array<<a href='/reference/typescript-api/orders/active-order-strategy#activeorderstrategy'>ActiveOrderStrategy</a><any>>`} default={`<a href='/reference/typescript-api/orders/default-active-order-strategy#defaultactiveorderstrategy'>DefaultActiveOrderStrategy</a>`} since="1.9.0" />
|
|
117
117
|
|
|
118
118
|
Defines the strategy used to determine the active Order when interacting with Shop API operations
|
|
119
119
|
such as `activeOrder` and `addItemToOrder`. By default, the strategy uses the active Session.
|
|
@@ -34,22 +34,22 @@ interface OrderProcess<State extends keyof CustomOrderStates | string> extends I
|
|
|
34
34
|
|
|
35
35
|
### transitions
|
|
36
36
|
|
|
37
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a
|
|
37
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a><State, State | <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>> & Partial<<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a><<a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a> | State>>`} />
|
|
38
38
|
|
|
39
39
|
|
|
40
40
|
### onTransitionStart
|
|
41
41
|
|
|
42
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a
|
|
42
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a><State | <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, <a href='/reference/typescript-api/orders/order-process#ordertransitiondata'>OrderTransitionData</a>>`} />
|
|
43
43
|
|
|
44
44
|
|
|
45
45
|
### onTransitionEnd
|
|
46
46
|
|
|
47
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a
|
|
47
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a><State | <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, <a href='/reference/typescript-api/orders/order-process#ordertransitiondata'>OrderTransitionData</a>>`} />
|
|
48
48
|
|
|
49
49
|
|
|
50
50
|
### onTransitionError
|
|
51
51
|
|
|
52
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a
|
|
52
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a><State | <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>>`} />
|
|
53
53
|
|
|
54
54
|
|
|
55
55
|
|
|
@@ -23,14 +23,14 @@ interface PaymentMethodConfigOptions<T extends ConfigArgs> extends ConfigurableO
|
|
|
23
23
|
|
|
24
24
|
### createPayment
|
|
25
25
|
|
|
26
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-types#createpaymentfn'>CreatePaymentFn</a
|
|
26
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-types#createpaymentfn'>CreatePaymentFn</a><T>`} />
|
|
27
27
|
|
|
28
28
|
This function provides the logic for creating a payment. For example,
|
|
29
29
|
it may call out to a third-party service with the data and should return a
|
|
30
30
|
<DocsLink href="/reference/typescript-api/payment/payment-method-types#createpaymentresult">CreatePaymentResult</DocsLink> object contains the details of the payment.
|
|
31
31
|
### settlePayment
|
|
32
32
|
|
|
33
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-types#settlepaymentfn'>SettlePaymentFn</a
|
|
33
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-types#settlepaymentfn'>SettlePaymentFn</a><T>`} />
|
|
34
34
|
|
|
35
35
|
This function provides the logic for settling a payment, also known as "capturing".
|
|
36
36
|
For payment integrations that settle/capture the payment on creation (i.e. the
|
|
@@ -38,7 +38,7 @@ For payment integrations that settle/capture the payment on creation (i.e. the
|
|
|
38
38
|
need only return `{ success: true }`.
|
|
39
39
|
### cancelPayment
|
|
40
40
|
|
|
41
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-types#cancelpaymentfn'>CancelPaymentFn</a
|
|
41
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-types#cancelpaymentfn'>CancelPaymentFn</a><T>`} since="1.7.0" />
|
|
42
42
|
|
|
43
43
|
This function provides the logic for cancelling a payment, which would be invoked when a call is
|
|
44
44
|
made to the `cancelPayment` mutation in the Admin API. Cancelling a payment can apply
|
|
@@ -47,7 +47,7 @@ completed the payment. It allows the incomplete payment to be cleaned up on the
|
|
|
47
47
|
if it gets cancelled via Vendure.
|
|
48
48
|
### createRefund
|
|
49
49
|
|
|
50
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-types#createrefundfn'>CreateRefundFn</a
|
|
50
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-types#createrefundfn'>CreateRefundFn</a><T>`} />
|
|
51
51
|
|
|
52
52
|
This function provides the logic for refunding a payment created with this
|
|
53
53
|
payment method. Some payment providers may not provide the facility to
|
|
@@ -55,7 +55,7 @@ programmatically create a refund. In such a case, this method should be
|
|
|
55
55
|
omitted and any Refunds will have to be settled manually by an administrator.
|
|
56
56
|
### onStateTransitionStart
|
|
57
57
|
|
|
58
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a
|
|
58
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a><<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>, <a href='/reference/typescript-api/payment/payment-transition-data#paymenttransitiondata'>PaymentTransitionData</a>>`} />
|
|
59
59
|
|
|
60
60
|
This function, when specified, will be invoked before any transition from one <DocsLink href="/reference/typescript-api/payment/payment-state#paymentstate">PaymentState</DocsLink> to another.
|
|
61
61
|
The return value (a sync / async `boolean`) is used to determine whether the transition is permitted.
|
|
@@ -35,7 +35,7 @@ class PaymentMethodEligibilityChecker<T extends ConfigArgs = ConfigArgs> extends
|
|
|
35
35
|
|
|
36
36
|
### constructor
|
|
37
37
|
|
|
38
|
-
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/payment/payment-method-eligibility-checker#paymentmethodeligibilitycheckerconfig'>PaymentMethodEligibilityCheckerConfig</a
|
|
38
|
+
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/payment/payment-method-eligibility-checker#paymentmethodeligibilitycheckerconfig'>PaymentMethodEligibilityCheckerConfig</a><T>) => PaymentMethodEligibilityChecker`} />
|
|
39
39
|
|
|
40
40
|
|
|
41
41
|
|
|
@@ -59,7 +59,7 @@ interface PaymentMethodEligibilityCheckerConfig<T extends ConfigArgs> extends Co
|
|
|
59
59
|
|
|
60
60
|
### check
|
|
61
61
|
|
|
62
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-eligibility-checker#checkpaymentmethodeligibilitycheckerfn'>CheckPaymentMethodEligibilityCheckerFn</a
|
|
62
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-eligibility-checker#checkpaymentmethodeligibilitycheckerfn'>CheckPaymentMethodEligibilityCheckerFn</a><T>`} />
|
|
63
63
|
|
|
64
64
|
|
|
65
65
|
|
|
@@ -70,7 +70,7 @@ class PaymentMethodHandler<T extends ConfigArgs = ConfigArgs> extends Configurab
|
|
|
70
70
|
|
|
71
71
|
### constructor
|
|
72
72
|
|
|
73
|
-
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/payment/payment-method-config-options#paymentmethodconfigoptions'>PaymentMethodConfigOptions</a
|
|
73
|
+
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/payment/payment-method-config-options#paymentmethodconfigoptions'>PaymentMethodConfigOptions</a><T>) => PaymentMethodHandler`} />
|
|
74
74
|
|
|
75
75
|
|
|
76
76
|
|
|
@@ -32,18 +32,18 @@ Defines which <DocsLink href="/reference/typescript-api/payment/payment-method-e
|
|
|
32
32
|
<DocsLink href="/reference/typescript-api/entities/payment-method#paymentmethod">PaymentMethod</DocsLink>s
|
|
33
33
|
### customPaymentProcess
|
|
34
34
|
|
|
35
|
-
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/payment/payment-process#paymentprocess'>PaymentProcess</a
|
|
35
|
+
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/payment/payment-process#paymentprocess'>PaymentProcess</a><any>>`} />
|
|
36
36
|
|
|
37
37
|
|
|
38
38
|
### process
|
|
39
39
|
|
|
40
|
-
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/payment/payment-process#paymentprocess'>PaymentProcess</a
|
|
40
|
+
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/payment/payment-process#paymentprocess'>PaymentProcess</a><any>>`} default={`<a href='/reference/typescript-api/payment/default-payment-process#defaultpaymentprocess'>defaultPaymentProcess</a>`} since="2.0.0" />
|
|
41
41
|
|
|
42
42
|
Allows the definition of custom states and transition logic for the payment process state machine.
|
|
43
43
|
Takes an array of objects implementing the <DocsLink href="/reference/typescript-api/payment/payment-process#paymentprocess">PaymentProcess</DocsLink> interface.
|
|
44
44
|
### refundProcess
|
|
45
45
|
|
|
46
|
-
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/payment/refund-process#refundprocess'>RefundProcess</a
|
|
46
|
+
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/payment/refund-process#refundprocess'>RefundProcess</a><any>>`} default={`<a href='/reference/typescript-api/payment/default-refund-process#defaultrefundprocess'>defaultRefundProcess</a>`} />
|
|
47
47
|
|
|
48
48
|
Allows the definition of custom states and transition logic for the refund process state machine.
|
|
49
49
|
Takes an array of objects implementing the <DocsLink href="/reference/typescript-api/payment/refund-process#refundprocess">RefundProcess</DocsLink> interface.
|
|
@@ -34,22 +34,22 @@ interface PaymentProcess<State extends keyof CustomPaymentStates | string> exten
|
|
|
34
34
|
|
|
35
35
|
### transitions
|
|
36
36
|
|
|
37
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a
|
|
37
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a><State, State | <a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>> & Partial<<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a><<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a> | State>>`} />
|
|
38
38
|
|
|
39
39
|
|
|
40
40
|
### onTransitionStart
|
|
41
41
|
|
|
42
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a
|
|
42
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a><State | <a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>, <a href='/reference/typescript-api/payment/payment-transition-data#paymenttransitiondata'>PaymentTransitionData</a>>`} />
|
|
43
43
|
|
|
44
44
|
|
|
45
45
|
### onTransitionEnd
|
|
46
46
|
|
|
47
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a
|
|
47
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a><State | <a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>, <a href='/reference/typescript-api/payment/payment-transition-data#paymenttransitiondata'>PaymentTransitionData</a>>`} />
|
|
48
48
|
|
|
49
49
|
|
|
50
50
|
### onTransitionError
|
|
51
51
|
|
|
52
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a
|
|
52
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a><State | <a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>>`} />
|
|
53
53
|
|
|
54
54
|
|
|
55
55
|
|
|
@@ -27,22 +27,22 @@ interface RefundProcess<State extends keyof CustomRefundStates | string> extends
|
|
|
27
27
|
|
|
28
28
|
### transitions
|
|
29
29
|
|
|
30
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a
|
|
30
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a><State, State | <a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a>> & Partial<<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a><<a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a> | State>>`} />
|
|
31
31
|
|
|
32
32
|
|
|
33
33
|
### onTransitionStart
|
|
34
34
|
|
|
35
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a
|
|
35
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a><State | <a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a>, <a href='/reference/typescript-api/payment/refund-transition-data#refundtransitiondata'>RefundTransitionData</a>>`} />
|
|
36
36
|
|
|
37
37
|
|
|
38
38
|
### onTransitionEnd
|
|
39
39
|
|
|
40
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a
|
|
40
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a><State | <a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a>, <a href='/reference/typescript-api/payment/refund-transition-data#refundtransitiondata'>RefundTransitionData</a>>`} />
|
|
41
41
|
|
|
42
42
|
|
|
43
43
|
### onTransitionError
|
|
44
44
|
|
|
45
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a
|
|
45
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a><State | <a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a>>`} />
|
|
46
46
|
|
|
47
47
|
|
|
48
48
|
|
|
@@ -21,7 +21,7 @@ interface CatalogOptions {
|
|
|
21
21
|
|
|
22
22
|
### collectionFilters
|
|
23
23
|
|
|
24
|
-
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/configuration/collection-filter#collectionfilter'>CollectionFilter</a
|
|
24
|
+
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/configuration/collection-filter#collectionfilter'>CollectionFilter</a><any>>`} default={`defaultCollectionFilters`} />
|
|
25
25
|
|
|
26
26
|
Allows custom <DocsLink href="/reference/typescript-api/configuration/collection-filter#collectionfilter">CollectionFilter</DocsLink>s to be defined.
|
|
27
27
|
### productVariantPriceSelectionStrategy
|
|
@@ -28,7 +28,7 @@ on the same Order. See the <DocsLink href="/reference/typescript-api/entities/pr
|
|
|
28
28
|
more information.
|
|
29
29
|
### constructor
|
|
30
30
|
|
|
31
|
-
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionactionconfig'>PromotionActionConfig</a
|
|
31
|
+
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionactionconfig'>PromotionActionConfig</a><T, U>) => PromotionAction`} />
|
|
32
32
|
|
|
33
33
|
|
|
34
34
|
|
|
@@ -65,7 +65,7 @@ class PromotionItemAction<T extends ConfigArgs = ConfigArgs, U extends Array<Pro
|
|
|
65
65
|
|
|
66
66
|
### constructor
|
|
67
67
|
|
|
68
|
-
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionitemactionconfig'>PromotionItemActionConfig</a
|
|
68
|
+
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionitemactionconfig'>PromotionItemActionConfig</a><T, U>) => PromotionItemAction`} />
|
|
69
69
|
|
|
70
70
|
|
|
71
71
|
|
|
@@ -102,7 +102,7 @@ class PromotionOrderAction<T extends ConfigArgs = ConfigArgs, U extends Promotio
|
|
|
102
102
|
|
|
103
103
|
### constructor
|
|
104
104
|
|
|
105
|
-
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionorderactionconfig'>PromotionOrderActionConfig</a
|
|
105
|
+
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionorderactionconfig'>PromotionOrderActionConfig</a><T, U>) => PromotionOrderAction`} />
|
|
106
106
|
|
|
107
107
|
|
|
108
108
|
|
|
@@ -125,7 +125,7 @@ class PromotionShippingAction<T extends ConfigArgs = ConfigArgs, U extends Promo
|
|
|
125
125
|
|
|
126
126
|
### constructor
|
|
127
127
|
|
|
128
|
-
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionshippingactionconfig'>PromotionShippingActionConfig</a
|
|
128
|
+
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionshippingactionconfig'>PromotionShippingActionConfig</a><T, U>) => PromotionShippingAction`} />
|
|
129
129
|
|
|
130
130
|
|
|
131
131
|
|
|
@@ -237,7 +237,7 @@ on which it depends.
|
|
|
237
237
|
the return values of the PromotionConditions' `check()` function.
|
|
238
238
|
### onActivate
|
|
239
239
|
|
|
240
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#promotionactionsideeffectfn'>PromotionActionSideEffectFn</a
|
|
240
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#promotionactionsideeffectfn'>PromotionActionSideEffectFn</a><T>`} since="1.8.0" experimental="true" />
|
|
241
241
|
|
|
242
242
|
An optional side effect function which is invoked when the promotion
|
|
243
243
|
becomes active. It can be used for things like adding a free gift to the order
|
|
@@ -247,7 +247,7 @@ If used, make sure to use the corresponding `onDeactivate` function to clean up
|
|
|
247
247
|
or reverse any side effects as needed.
|
|
248
248
|
### onDeactivate
|
|
249
249
|
|
|
250
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#promotionactionsideeffectfn'>PromotionActionSideEffectFn</a
|
|
250
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#promotionactionsideeffectfn'>PromotionActionSideEffectFn</a><T>`} since="1.8.0" experimental="true" />
|
|
251
251
|
|
|
252
252
|
Used to reverse or clean up any side effects executed as part of the `onActivate` function.
|
|
253
253
|
|
|
@@ -270,7 +270,7 @@ interface PromotionItemActionConfig<T extends ConfigArgs, U extends PromotionCon
|
|
|
270
270
|
|
|
271
271
|
### execute
|
|
272
272
|
|
|
273
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#executepromotionitemactionfn'>ExecutePromotionItemActionFn</a
|
|
273
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#executepromotionitemactionfn'>ExecutePromotionItemActionFn</a><T, U>`} />
|
|
274
274
|
|
|
275
275
|
The function which contains the promotion calculation logic.
|
|
276
276
|
Should resolve to a number which represents the amount by which to discount
|
|
@@ -295,7 +295,7 @@ interface PromotionLineActionConfig<T extends ConfigArgs, U extends PromotionCon
|
|
|
295
295
|
|
|
296
296
|
### execute
|
|
297
297
|
|
|
298
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#executepromotionlineactionfn'>ExecutePromotionLineActionFn</a
|
|
298
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#executepromotionlineactionfn'>ExecutePromotionLineActionFn</a><T, U>`} />
|
|
299
299
|
|
|
300
300
|
The function which contains the promotion calculation logic.
|
|
301
301
|
Should resolve to a number which represents the amount by which to discount
|
|
@@ -320,7 +320,7 @@ interface PromotionOrderActionConfig<T extends ConfigArgs, U extends PromotionCo
|
|
|
320
320
|
|
|
321
321
|
### execute
|
|
322
322
|
|
|
323
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#executepromotionorderactionfn'>ExecutePromotionOrderActionFn</a
|
|
323
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#executepromotionorderactionfn'>ExecutePromotionOrderActionFn</a><T, U>`} />
|
|
324
324
|
|
|
325
325
|
The function which contains the promotion calculation logic.
|
|
326
326
|
Should resolve to a number which represents the amount by which to discount
|
|
@@ -345,7 +345,7 @@ interface PromotionShippingActionConfig<T extends ConfigArgs, U extends Promotio
|
|
|
345
345
|
|
|
346
346
|
### execute
|
|
347
347
|
|
|
348
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#executepromotionshippingactionfn'>ExecutePromotionShippingActionFn</a
|
|
348
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/promotions/promotion-action#executepromotionshippingactionfn'>ExecutePromotionShippingActionFn</a><T, U>`} />
|
|
349
349
|
|
|
350
350
|
The function which contains the promotion calculation logic.
|
|
351
351
|
Should resolve to a number which represents the amount by which to discount
|
|
@@ -385,7 +385,7 @@ class PromotionLineAction<T extends ConfigArgs = ConfigArgs, U extends Array<Pro
|
|
|
385
385
|
|
|
386
386
|
### constructor
|
|
387
387
|
|
|
388
|
-
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionlineactionconfig'>PromotionLineActionConfig</a
|
|
388
|
+
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/promotions/promotion-action#promotionlineactionconfig'>PromotionLineActionConfig</a><T, U>) => PromotionLineAction`} />
|
|
389
389
|
|
|
390
390
|
|
|
391
391
|
|