@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
|
@@ -97,7 +97,7 @@ This means that the subscriber function can safely access all updated
|
|
|
97
97
|
data related to the event.
|
|
98
98
|
### registerBlockingEventHandler
|
|
99
99
|
|
|
100
|
-
<MemberInfo kind="method" type={`(handlerOptions: <a href='/reference/typescript-api/events/blocking-event-handler-options#blockingeventhandleroptions'>BlockingEventHandlerOptions</a
|
|
100
|
+
<MemberInfo kind="method" type={`(handlerOptions: <a href='/reference/typescript-api/events/blocking-event-handler-options#blockingeventhandleroptions'>BlockingEventHandlerOptions</a>`<T>`) => `} since="2.2.0" />
|
|
101
101
|
|
|
102
102
|
Register an event handler function which will be executed when an event of the given type is published,
|
|
103
103
|
and will block execution of the code which published the event until the handler has completed.
|
|
@@ -59,7 +59,7 @@ class AdministratorEvent extends VendureEntityEvent<Administrator, Administrator
|
|
|
59
59
|
constructor(ctx: RequestContext, entity: Administrator, type: 'created' | 'updated' | 'deleted', input?: AdministratorInputTypes)
|
|
60
60
|
}
|
|
61
61
|
```
|
|
62
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
62
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`<`<DocsLink href="/reference/typescript-api/entities/administrator#administrator">`Administrator`</DocsLink>`, AdministratorInputTypes>`
|
|
63
63
|
|
|
64
64
|
|
|
65
65
|
|
|
@@ -107,7 +107,7 @@ class AssetEvent extends VendureEntityEvent<Asset, AssetInputTypes> {
|
|
|
107
107
|
asset: Asset
|
|
108
108
|
}
|
|
109
109
|
```
|
|
110
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
110
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`<`<DocsLink href="/reference/typescript-api/entities/asset#asset">`Asset`</DocsLink>`, AssetInputTypes>`
|
|
111
111
|
|
|
112
112
|
|
|
113
113
|
|
|
@@ -184,7 +184,7 @@ class ChannelEvent extends VendureEntityEvent<Channel, ChannelInputTypes> {
|
|
|
184
184
|
constructor(ctx: RequestContext, entity: Channel, type: 'created' | 'updated' | 'deleted', input?: ChannelInputTypes)
|
|
185
185
|
}
|
|
186
186
|
```
|
|
187
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
187
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`<`<DocsLink href="/reference/typescript-api/entities/channel#channel">`Channel`</DocsLink>`, ChannelInputTypes>`
|
|
188
188
|
|
|
189
189
|
|
|
190
190
|
|
|
@@ -207,7 +207,7 @@ class CollectionEvent extends VendureEntityEvent<Collection, CollectionInputType
|
|
|
207
207
|
constructor(ctx: RequestContext, entity: Collection, type: 'created' | 'updated' | 'deleted', input?: CollectionInputTypes)
|
|
208
208
|
}
|
|
209
209
|
```
|
|
210
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
210
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`<`<DocsLink href="/reference/typescript-api/entities/collection#collection">`Collection`</DocsLink>`, CollectionInputTypes>`
|
|
211
211
|
|
|
212
212
|
|
|
213
213
|
|
|
@@ -257,7 +257,7 @@ class CountryEvent extends VendureEntityEvent<Country, CountryInputTypes> {
|
|
|
257
257
|
constructor(ctx: RequestContext, entity: Country, type: 'created' | 'updated' | 'deleted', input?: CountryInputTypes)
|
|
258
258
|
}
|
|
259
259
|
```
|
|
260
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
260
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`<`<DocsLink href="/reference/typescript-api/entities/country#country">`Country`</DocsLink>`, CountryInputTypes>`
|
|
261
261
|
|
|
262
262
|
|
|
263
263
|
|
|
@@ -306,7 +306,7 @@ class CustomerAddressEvent extends VendureEntityEvent<Address, CustomerAddressIn
|
|
|
306
306
|
address: Address
|
|
307
307
|
}
|
|
308
308
|
```
|
|
309
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
309
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`<`<DocsLink href="/reference/typescript-api/entities/address#address">`Address`</DocsLink>`, CustomerAddressInputTypes>`
|
|
310
310
|
|
|
311
311
|
|
|
312
312
|
|
|
@@ -336,7 +336,7 @@ class CustomerEvent extends VendureEntityEvent<Customer, CustomerInputTypes> {
|
|
|
336
336
|
customer: Customer
|
|
337
337
|
}
|
|
338
338
|
```
|
|
339
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
339
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`<`<DocsLink href="/reference/typescript-api/entities/customer#customer">`Customer`</DocsLink>`, CustomerInputTypes>`
|
|
340
340
|
|
|
341
341
|
|
|
342
342
|
|
|
@@ -388,7 +388,7 @@ class CustomerGroupEvent extends VendureEntityEvent<CustomerGroup, CustomerGroup
|
|
|
388
388
|
constructor(ctx: RequestContext, entity: CustomerGroup, type: 'created' | 'updated' | 'deleted', input?: CustomerGroupInputTypes)
|
|
389
389
|
}
|
|
390
390
|
```
|
|
391
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
391
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`<`<DocsLink href="/reference/typescript-api/entities/customer-group#customergroup">`CustomerGroup`</DocsLink>`, CustomerGroupInputTypes>`
|
|
392
392
|
|
|
393
393
|
|
|
394
394
|
|
|
@@ -411,7 +411,7 @@ class FacetEvent extends VendureEntityEvent<Facet, FacetInputTypes> {
|
|
|
411
411
|
constructor(ctx: RequestContext, entity: Facet, type: 'created' | 'updated' | 'deleted', input?: FacetInputTypes)
|
|
412
412
|
}
|
|
413
413
|
```
|
|
414
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
414
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`<`<DocsLink href="/reference/typescript-api/entities/facet#facet">`Facet`</DocsLink>`, FacetInputTypes>`
|
|
415
415
|
|
|
416
416
|
|
|
417
417
|
|
|
@@ -434,7 +434,7 @@ class FacetValueEvent extends VendureEntityEvent<FacetValue, FacetValueInputType
|
|
|
434
434
|
constructor(ctx: RequestContext, entity: FacetValue, type: 'created' | 'updated' | 'deleted', input?: FacetValueInputTypes)
|
|
435
435
|
}
|
|
436
436
|
```
|
|
437
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
437
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`<`<DocsLink href="/reference/typescript-api/entities/facet-value#facetvalue">`FacetValue`</DocsLink>`, FacetValueInputTypes>`
|
|
438
438
|
|
|
439
439
|
|
|
440
440
|
|
|
@@ -457,7 +457,7 @@ class FulfillmentEvent extends VendureEntityEvent<Fulfillment, CreateFulfillment
|
|
|
457
457
|
constructor(ctx: RequestContext, entity: Fulfillment, input?: CreateFulfillmentInput)
|
|
458
458
|
}
|
|
459
459
|
```
|
|
460
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
460
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`<`<DocsLink href="/reference/typescript-api/entities/fulfillment#fulfillment">`Fulfillment`</DocsLink>`, CreateFulfillmentInput>`
|
|
461
461
|
|
|
462
462
|
|
|
463
463
|
|
|
@@ -504,7 +504,7 @@ class GlobalSettingsEvent extends VendureEntityEvent<GlobalSettings, UpdateGloba
|
|
|
504
504
|
constructor(ctx: RequestContext, entity: GlobalSettings, input?: UpdateGlobalSettingsInput)
|
|
505
505
|
}
|
|
506
506
|
```
|
|
507
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
507
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`<`<DocsLink href="/reference/typescript-api/entities/global-settings#globalsettings">`GlobalSettings`</DocsLink>`, UpdateGlobalSettingsInput>`
|
|
508
508
|
|
|
509
509
|
|
|
510
510
|
|
|
@@ -528,7 +528,7 @@ class HistoryEntryEvent extends VendureEntityEvent<HistoryEntry, HistoryInput> {
|
|
|
528
528
|
constructor(ctx: RequestContext, entity: HistoryEntry, type: 'created' | 'updated' | 'deleted', historyType: 'order' | 'customer' | string, input?: HistoryInput)
|
|
529
529
|
}
|
|
530
530
|
```
|
|
531
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
531
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`<`<DocsLink href="/reference/typescript-api/entities/history-entry#historyentry">`HistoryEntry`</DocsLink>`, HistoryInput>`
|
|
532
532
|
|
|
533
533
|
|
|
534
534
|
|
|
@@ -675,7 +675,7 @@ class OrderEvent extends VendureEntityEvent<Order, OrderInputTypes> {
|
|
|
675
675
|
order: Order
|
|
676
676
|
}
|
|
677
677
|
```
|
|
678
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
678
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`<`<DocsLink href="/reference/typescript-api/entities/order#order">`Order`</DocsLink>`, OrderInputTypes>`
|
|
679
679
|
|
|
680
680
|
|
|
681
681
|
|
|
@@ -824,7 +824,7 @@ class PaymentMethodEvent extends VendureEntityEvent<PaymentMethod, PaymentMethod
|
|
|
824
824
|
constructor(ctx: RequestContext, entity: PaymentMethod, type: 'created' | 'updated' | 'deleted', input?: PaymentMethodInputTypes)
|
|
825
825
|
}
|
|
826
826
|
```
|
|
827
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
827
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`<`<DocsLink href="/reference/typescript-api/entities/payment-method#paymentmethod">`PaymentMethod`</DocsLink>`, PaymentMethodInputTypes>`
|
|
828
828
|
|
|
829
829
|
|
|
830
830
|
|
|
@@ -897,7 +897,7 @@ class ProductEvent extends VendureEntityEvent<Product, ProductInputTypes> {
|
|
|
897
897
|
product: Product
|
|
898
898
|
}
|
|
899
899
|
```
|
|
900
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
900
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`<`<DocsLink href="/reference/typescript-api/entities/product#product">`Product`</DocsLink>`, ProductInputTypes>`
|
|
901
901
|
|
|
902
902
|
|
|
903
903
|
|
|
@@ -925,7 +925,7 @@ class ProductOptionEvent extends VendureEntityEvent<ProductOption, ProductOption
|
|
|
925
925
|
constructor(ctx: RequestContext, entity: ProductOption, type: 'created' | 'updated' | 'deleted', input?: ProductOptionInputTypes)
|
|
926
926
|
}
|
|
927
927
|
```
|
|
928
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
928
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`<`<DocsLink href="/reference/typescript-api/entities/product-option#productoption">`ProductOption`</DocsLink>`, ProductOptionInputTypes>`
|
|
929
929
|
|
|
930
930
|
|
|
931
931
|
|
|
@@ -974,7 +974,7 @@ class ProductOptionGroupEvent extends VendureEntityEvent<
|
|
|
974
974
|
constructor(ctx: RequestContext, entity: ProductOptionGroup, type: 'created' | 'updated' | 'deleted', input?: ProductOptionGroupInputTypes)
|
|
975
975
|
}
|
|
976
976
|
```
|
|
977
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
977
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`< `<DocsLink href="/reference/typescript-api/entities/product-option-group#productoptiongroup">`ProductOptionGroup`</DocsLink>`, ProductOptionGroupInputTypes >`
|
|
978
978
|
|
|
979
979
|
|
|
980
980
|
|
|
@@ -1022,7 +1022,7 @@ class ProductVariantEvent extends VendureEntityEvent<ProductVariant[], ProductVa
|
|
|
1022
1022
|
variants: ProductVariant[]
|
|
1023
1023
|
}
|
|
1024
1024
|
```
|
|
1025
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
1025
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`<`<DocsLink href="/reference/typescript-api/entities/product-variant#productvariant">`ProductVariant`</DocsLink>`[], ProductVariantInputTypes>`
|
|
1026
1026
|
|
|
1027
1027
|
|
|
1028
1028
|
|
|
@@ -1053,7 +1053,7 @@ class ProductVariantPriceEvent extends VendureEntityEvent<
|
|
|
1053
1053
|
constructor(ctx: RequestContext, entity: ProductVariantPrice[], type: 'created' | 'updated' | 'deleted', input?: ProductVariantInputTypes)
|
|
1054
1054
|
}
|
|
1055
1055
|
```
|
|
1056
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
1056
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`< `<DocsLink href="/reference/typescript-api/entities/product-variant-price#productvariantprice">`ProductVariantPrice`</DocsLink>`[], ProductVariantInputTypes >`
|
|
1057
1057
|
|
|
1058
1058
|
|
|
1059
1059
|
|
|
@@ -1077,7 +1077,7 @@ class PromotionEvent extends VendureEntityEvent<Promotion, PromotionInputTypes>
|
|
|
1077
1077
|
constructor(ctx: RequestContext, entity: Promotion, type: 'created' | 'updated' | 'deleted', input?: PromotionInputTypes)
|
|
1078
1078
|
}
|
|
1079
1079
|
```
|
|
1080
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
1080
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`<`<DocsLink href="/reference/typescript-api/entities/promotion#promotion">`Promotion`</DocsLink>`, PromotionInputTypes>`
|
|
1081
1081
|
|
|
1082
1082
|
|
|
1083
1083
|
|
|
@@ -1100,7 +1100,7 @@ class ProvinceEvent extends VendureEntityEvent<Province, ProvinceInputTypes> {
|
|
|
1100
1100
|
constructor(ctx: RequestContext, entity: Province, type: 'created' | 'updated' | 'deleted', input?: ProvinceInputTypes)
|
|
1101
1101
|
}
|
|
1102
1102
|
```
|
|
1103
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
1103
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`<`<DocsLink href="/reference/typescript-api/entities/province#province">`Province`</DocsLink>`, ProvinceInputTypes>`
|
|
1104
1104
|
|
|
1105
1105
|
|
|
1106
1106
|
|
|
@@ -1193,7 +1193,7 @@ class RoleEvent extends VendureEntityEvent<Role, RoleInputTypes> {
|
|
|
1193
1193
|
constructor(ctx: RequestContext, entity: Role, type: 'created' | 'updated' | 'deleted', input?: RoleInputTypes)
|
|
1194
1194
|
}
|
|
1195
1195
|
```
|
|
1196
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
1196
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`<`<DocsLink href="/reference/typescript-api/entities/role#role">`Role`</DocsLink>`, RoleInputTypes>`
|
|
1197
1197
|
|
|
1198
1198
|
|
|
1199
1199
|
|
|
@@ -1239,7 +1239,7 @@ class SellerEvent extends VendureEntityEvent<Seller, SellerInputTypes> {
|
|
|
1239
1239
|
constructor(ctx: RequestContext, entity: Seller, type: 'created' | 'updated' | 'deleted', input?: SellerInputTypes)
|
|
1240
1240
|
}
|
|
1241
1241
|
```
|
|
1242
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
1242
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`<`<DocsLink href="/reference/typescript-api/entities/seller#seller">`Seller`</DocsLink>`, SellerInputTypes>`
|
|
1243
1243
|
|
|
1244
1244
|
|
|
1245
1245
|
|
|
@@ -1263,7 +1263,7 @@ class ShippingMethodEvent extends VendureEntityEvent<ShippingMethod, ShippingMet
|
|
|
1263
1263
|
constructor(ctx: RequestContext, entity: ShippingMethod, type: 'created' | 'updated' | 'deleted', input?: ShippingMethodInputTypes)
|
|
1264
1264
|
}
|
|
1265
1265
|
```
|
|
1266
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
1266
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`<`<DocsLink href="/reference/typescript-api/entities/shipping-method#shippingmethod">`ShippingMethod`</DocsLink>`, ShippingMethodInputTypes>`
|
|
1267
1267
|
|
|
1268
1268
|
|
|
1269
1269
|
|
|
@@ -1287,7 +1287,7 @@ class StockLocationEvent extends VendureEntityEvent<StockLocation, StockLocation
|
|
|
1287
1287
|
constructor(ctx: RequestContext, entity: StockLocation, type: 'created' | 'updated' | 'deleted', input?: StockLocationInputTypes)
|
|
1288
1288
|
}
|
|
1289
1289
|
```
|
|
1290
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
1290
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`<`<DocsLink href="/reference/typescript-api/entities/stock-location#stocklocation">`StockLocation`</DocsLink>`, StockLocationInputTypes>`
|
|
1291
1291
|
|
|
1292
1292
|
|
|
1293
1293
|
|
|
@@ -1341,7 +1341,7 @@ class TaxCategoryEvent extends VendureEntityEvent<TaxCategory, TaxCategoryInputT
|
|
|
1341
1341
|
constructor(ctx: RequestContext, entity: TaxCategory, type: 'created' | 'updated' | 'deleted', input?: TaxCategoryInputTypes)
|
|
1342
1342
|
}
|
|
1343
1343
|
```
|
|
1344
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
1344
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`<`<DocsLink href="/reference/typescript-api/entities/tax-category#taxcategory">`TaxCategory`</DocsLink>`, TaxCategoryInputTypes>`
|
|
1345
1345
|
|
|
1346
1346
|
|
|
1347
1347
|
|
|
@@ -1365,7 +1365,7 @@ class TaxRateEvent extends VendureEntityEvent<TaxRate, TaxRateInputTypes> {
|
|
|
1365
1365
|
constructor(ctx: RequestContext, entity: TaxRate, type: 'created' | 'updated' | 'deleted', input?: TaxRateInputTypes)
|
|
1366
1366
|
}
|
|
1367
1367
|
```
|
|
1368
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
1368
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`<`<DocsLink href="/reference/typescript-api/entities/tax-rate#taxrate">`TaxRate`</DocsLink>`, TaxRateInputTypes>`
|
|
1369
1369
|
|
|
1370
1370
|
|
|
1371
1371
|
|
|
@@ -1412,7 +1412,7 @@ class ZoneEvent extends VendureEntityEvent<Zone, ZoneInputTypes> {
|
|
|
1412
1412
|
constructor(ctx: RequestContext, entity: Zone, type: 'created' | 'updated' | 'deleted', input?: ZoneInputTypes)
|
|
1413
1413
|
}
|
|
1414
1414
|
```
|
|
1415
|
-
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink
|
|
1415
|
+
* Extends: <DocsLink href="/reference/typescript-api/events/vendure-entity-event#vendureentityevent">`VendureEntityEvent`</DocsLink>`<`<DocsLink href="/reference/typescript-api/entities/zone#zone">`Zone`</DocsLink>`, ZoneInputTypes>`
|
|
1416
1416
|
|
|
1417
1417
|
|
|
1418
1418
|
|
|
@@ -83,7 +83,7 @@ class FulfillmentHandler<T extends ConfigArgs = ConfigArgs> extends Configurable
|
|
|
83
83
|
constructor(config: FulfillmentHandlerConfig<T>)
|
|
84
84
|
}
|
|
85
85
|
```
|
|
86
|
-
* Extends: <DocsLink href="/reference/typescript-api/configurable-operation-def/#configurableoperationdef">`ConfigurableOperationDef`</DocsLink
|
|
86
|
+
* Extends: <DocsLink href="/reference/typescript-api/configurable-operation-def/#configurableoperationdef">`ConfigurableOperationDef`</DocsLink>`<T>`
|
|
87
87
|
|
|
88
88
|
|
|
89
89
|
|
|
@@ -91,7 +91,7 @@ class FulfillmentHandler<T extends ConfigArgs = ConfigArgs> extends Configurable
|
|
|
91
91
|
|
|
92
92
|
### constructor
|
|
93
93
|
|
|
94
|
-
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/fulfillment/fulfillment-handler#fulfillmenthandlerconfig'>FulfillmentHandlerConfig</a
|
|
94
|
+
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/fulfillment/fulfillment-handler#fulfillmenthandlerconfig'>FulfillmentHandlerConfig</a>`<T>`) => FulfillmentHandler`} />
|
|
95
95
|
|
|
96
96
|
|
|
97
97
|
|
|
@@ -107,7 +107,7 @@ interface FulfillmentHandlerConfig<T extends ConfigArgs> extends ConfigurableOpe
|
|
|
107
107
|
onFulfillmentTransition?: OnTransitionStartFn<FulfillmentState, FulfillmentTransitionData>;
|
|
108
108
|
}
|
|
109
109
|
```
|
|
110
|
-
* Extends: <DocsLink href="/reference/typescript-api/configurable-operation-def/configurable-operation-def-options#configurableoperationdefoptions">`ConfigurableOperationDefOptions`</DocsLink
|
|
110
|
+
* Extends: <DocsLink href="/reference/typescript-api/configurable-operation-def/configurable-operation-def-options#configurableoperationdefoptions">`ConfigurableOperationDefOptions`</DocsLink>`<T>`
|
|
111
111
|
|
|
112
112
|
|
|
113
113
|
|
|
@@ -115,7 +115,7 @@ interface FulfillmentHandlerConfig<T extends ConfigArgs> extends ConfigurableOpe
|
|
|
115
115
|
|
|
116
116
|
### createFulfillment
|
|
117
117
|
|
|
118
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/fulfillment/fulfillment-handler#createfulfillmentfn'>CreateFulfillmentFn</a
|
|
118
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/fulfillment/fulfillment-handler#createfulfillmentfn'>CreateFulfillmentFn</a>`<T>``} />
|
|
119
119
|
|
|
120
120
|
Invoked when the `addFulfillmentToOrder` mutation is executed with this handler selected.
|
|
121
121
|
|
|
@@ -123,7 +123,7 @@ If an Error is thrown from within this function, no Fulfillment is created and t
|
|
|
123
123
|
result will be returned.
|
|
124
124
|
### onFulfillmentTransition
|
|
125
125
|
|
|
126
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a
|
|
126
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a>`<<a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>`FulfillmentState</a>, <a href='/reference/typescript-api/fulfillment/fulfillment-transition-data#fulfillmenttransitiondata'>FulfillmentTransitionData</a>>`} />
|
|
127
127
|
|
|
128
128
|
This allows the handler to intercept state transitions of the created Fulfillment. This works much in the
|
|
129
129
|
same way as the <DocsLink href="/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess">FulfillmentProcess</DocsLink> `onTransitionStart` method (i.e. returning `false` or
|
|
@@ -39,22 +39,22 @@ interface FulfillmentProcess<State extends keyof CustomFulfillmentStates | strin
|
|
|
39
39
|
|
|
40
40
|
### transitions
|
|
41
41
|
|
|
42
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a
|
|
42
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<State, State | <a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>`FulfillmentState</a>> & Partial<<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<<a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>`FulfillmentState</a> | State>>`} />
|
|
43
43
|
|
|
44
44
|
|
|
45
45
|
### onTransitionStart
|
|
46
46
|
|
|
47
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a
|
|
47
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a>`<State | <a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>`FulfillmentState</a>, <a href='/reference/typescript-api/fulfillment/fulfillment-transition-data#fulfillmenttransitiondata'>FulfillmentTransitionData</a>>`} />
|
|
48
48
|
|
|
49
49
|
|
|
50
50
|
### onTransitionEnd
|
|
51
51
|
|
|
52
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a
|
|
52
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a>`<State | <a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>`FulfillmentState</a>, <a href='/reference/typescript-api/fulfillment/fulfillment-transition-data#fulfillmenttransitiondata'>FulfillmentTransitionData</a>>`} />
|
|
53
53
|
|
|
54
54
|
|
|
55
55
|
### onTransitionError
|
|
56
56
|
|
|
57
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a
|
|
57
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a>`<State | <a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>`FulfillmentState</a>>`} />
|
|
58
58
|
|
|
59
59
|
|
|
60
60
|
|
|
@@ -17,7 +17,7 @@ class ImportParser {
|
|
|
17
17
|
|
|
18
18
|
### parseProducts
|
|
19
19
|
|
|
20
|
-
<MemberInfo kind="method" type={`(input: string | Stream, mainLanguage: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a> = this.configService.defaultLanguageCode) => Promise<<a href='/reference/typescript-api/import-export/import-parser#parseresult'>ParseResult</a
|
|
20
|
+
<MemberInfo kind="method" type={`(input: string | Stream, mainLanguage: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a> = this.configService.defaultLanguageCode) => Promise<<a href='/reference/typescript-api/import-export/import-parser#parseresult'>ParseResult</a>`<<a href='/reference/typescript-api/import-export/import-parser#parsedproductwithvariants'>`ParsedProductWithVariants</a>>>`} />
|
|
21
21
|
|
|
22
22
|
Parses the contents of the [product import CSV file](/guides/developer-guide/importing-data/#product-import-format) and
|
|
23
23
|
returns a data structure which can then be used to populate Vendure using the <DocsLink href="/reference/typescript-api/import-export/fast-importer-service#fastimporterservice">FastImporterService</DocsLink>.
|
|
@@ -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
|
|
@@ -15,7 +15,7 @@ class SubscribableJob<T extends JobData<T> = any> extends Job<T> {
|
|
|
15
15
|
updates(options?: JobUpdateOptions) => Observable<JobUpdate<T>>;
|
|
16
16
|
}
|
|
17
17
|
```
|
|
18
|
-
* Extends: <DocsLink href="/reference/typescript-api/job-queue/job#job">`Job`</DocsLink
|
|
18
|
+
* Extends: <DocsLink href="/reference/typescript-api/job-queue/job#job">`Job`</DocsLink>`<T>`
|
|
19
19
|
|
|
20
20
|
|
|
21
21
|
|
|
@@ -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.
|