@vendure/docs 0.0.0-202601201808 → 0.0.0-202601210957
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/action-bar/action-bar-context.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +2 -2
- package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +3 -3
- package/docs/reference/admin-ui-api/alerts/alert-config.mdx +5 -5
- package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +6 -6
- package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +4 -4
- package/docs/reference/admin-ui-api/components/currency-input-component.mdx +4 -4
- package/docs/reference/admin-ui-api/components/data-table-component.mdx +5 -5
- package/docs/reference/admin-ui-api/components/data-table2component.mdx +7 -7
- package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +7 -7
- package/docs/reference/admin-ui-api/components/dropdown-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +6 -6
- package/docs/reference/admin-ui-api/components/object-tree-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +2 -2
- package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +3 -3
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +4 -4
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +22 -22
- package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.mdx +1 -1
- package/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx +2 -2
- package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +2 -2
- package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +6 -6
- package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +8 -8
- 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 +3 -3
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +7 -7
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx +3 -3
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/action-bar.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/card.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/cds-icon.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/form-field.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/link.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-injector.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-query.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 +10 -10
- package/docs/reference/admin-ui-api/services/modal-service.mdx +5 -5
- package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx +1 -1
- package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +2 -2
- package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +2 -2
- package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +8 -8
- package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +2 -2
- package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +1 -1
- package/docs/reference/core-plugins/dashboard-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +8 -8
- package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
- 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-generator.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +3 -3
- package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-sender.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/template-loader.mdx +4 -4
- package/docs/reference/core-plugins/email-plugin/transport-options.mdx +1 -1
- package/docs/reference/core-plugins/graphiql-plugin/index.mdx +2 -2
- package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +9 -9
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +5 -5
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +3 -3
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx +1 -1
- package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx +2 -2
- package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx +1 -1
- package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +5 -5
- package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +4 -4
- package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +2 -2
- package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -1
- package/docs/reference/dashboard/components/asset-gallery.mdx +3 -3
- package/docs/reference/dashboard/components/asset-picker-dialog.mdx +2 -2
- package/docs/reference/dashboard/components/channel-chip.mdx +1 -1
- package/docs/reference/dashboard/components/detail-page-button.mdx +1 -1
- package/docs/reference/dashboard/components/facet-value-selector.mdx +1 -1
- package/docs/reference/dashboard/components/permission-guard.mdx +1 -1
- package/docs/reference/dashboard/components/vendure-image.mdx +2 -2
- package/docs/reference/dashboard/detail-views/detail-page.mdx +3 -3
- package/docs/reference/dashboard/detail-views/use-detail-page.mdx +11 -11
- package/docs/reference/dashboard/detail-views/use-generated-form.mdx +3 -3
- package/docs/reference/dashboard/extensions-api/action-bar.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/alerts.mdx +6 -6
- package/docs/reference/dashboard/extensions-api/data-tables.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/detail-forms.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/history-entries.mdx +2 -2
- package/docs/reference/dashboard/extensions-api/page-blocks.mdx +2 -2
- package/docs/reference/dashboard/extensions-api/routes.mdx +4 -4
- package/docs/reference/dashboard/extensions-api/widgets.mdx +1 -1
- package/docs/reference/dashboard/form-components/affixed-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/boolean-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/checkbox-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/date-time-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
- package/docs/reference/dashboard/form-components/money-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/number-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/password-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/rich-text-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/textarea-input.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-alerts.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-auth.mdx +5 -5
- package/docs/reference/dashboard/hooks/use-channel.mdx +2 -2
- package/docs/reference/dashboard/hooks/use-drag-and-drop.mdx +1 -1
- package/docs/reference/dashboard/list-views/bulk-actions.mdx +3 -3
- package/docs/reference/dashboard/list-views/data-table.mdx +10 -10
- package/docs/reference/dashboard/list-views/list-page.mdx +13 -13
- package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +17 -17
- package/docs/reference/dashboard/page-layout/index.mdx +1 -1
- package/docs/reference/dashboard/page-layout/page-action-bar.mdx +3 -3
- package/docs/reference/dashboard/page-layout/page-block.mdx +3 -3
- package/docs/reference/dashboard/page-layout/page-title.mdx +1 -1
- package/docs/reference/dashboard/page-layout/page.mdx +3 -3
- package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +6 -6
- package/docs/reference/typescript-api/auth/auth-options.mdx +1 -1
- package/docs/reference/typescript-api/auth/authentication-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/auth/external-authentication-service.mdx +5 -5
- package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +3 -3
- package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/permission-definition.mdx +2 -2
- package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +2 -2
- package/docs/reference/typescript-api/cache/cache-config.mdx +1 -1
- package/docs/reference/typescript-api/cache/cache-service.mdx +4 -4
- package/docs/reference/typescript-api/cache/cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/cache/index.mdx +3 -3
- package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/cache/request-context-cache-service.mdx +2 -2
- package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +6 -6
- package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx +1 -1
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx +1 -1
- package/docs/reference/typescript-api/common/async-queue.mdx +1 -1
- package/docs/reference/typescript-api/common/bootstrap.mdx +2 -2
- package/docs/reference/typescript-api/common/injectable-strategy.mdx +2 -2
- package/docs/reference/typescript-api/common/injector.mdx +2 -2
- package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +1 -1
- package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx +11 -11
- package/docs/reference/typescript-api/configurable-operation-def/index.mdx +2 -2
- package/docs/reference/typescript-api/configuration/api-options.mdx +2 -2
- package/docs/reference/typescript-api/configuration/collection-filter.mdx +3 -3
- package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +6 -6
- package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +4 -4
- package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
- package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +3 -3
- package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +15 -15
- package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/vendure-config.mdx +2 -2
- package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +1 -1
- package/docs/reference/typescript-api/data-access/calculated.mdx +1 -1
- package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
- package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.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 +4 -4
- package/docs/reference/typescript-api/data-access/transactional-connection.mdx +9 -9
- package/docs/reference/typescript-api/default-search-plugin/index.mdx +1 -1
- package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/entities/address.mdx +1 -1
- package/docs/reference/typescript-api/entities/administrator.mdx +1 -1
- package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
- package/docs/reference/typescript-api/entities/asset.mdx +1 -1
- package/docs/reference/typescript-api/entities/authenticated-session.mdx +1 -1
- package/docs/reference/typescript-api/entities/authentication-method.mdx +2 -2
- package/docs/reference/typescript-api/entities/channel.mdx +1 -1
- package/docs/reference/typescript-api/entities/collection.mdx +2 -2
- package/docs/reference/typescript-api/entities/country.mdx +1 -1
- package/docs/reference/typescript-api/entities/customer-group.mdx +1 -1
- package/docs/reference/typescript-api/entities/customer-history-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/customer.mdx +1 -1
- package/docs/reference/typescript-api/entities/facet-value.mdx +2 -2
- package/docs/reference/typescript-api/entities/facet.mdx +2 -2
- package/docs/reference/typescript-api/entities/fulfillment.mdx +1 -1
- package/docs/reference/typescript-api/entities/global-settings.mdx +1 -1
- package/docs/reference/typescript-api/entities/interfaces.mdx +1 -1
- package/docs/reference/typescript-api/entities/order-history-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/order-line-reference.mdx +3 -3
- package/docs/reference/typescript-api/entities/order-line.mdx +1 -1
- package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
- package/docs/reference/typescript-api/entities/order.mdx +1 -1
- package/docs/reference/typescript-api/entities/orderable-asset.mdx +1 -1
- package/docs/reference/typescript-api/entities/payment-method.mdx +2 -2
- package/docs/reference/typescript-api/entities/payment.mdx +1 -1
- package/docs/reference/typescript-api/entities/product-option-group.mdx +2 -2
- package/docs/reference/typescript-api/entities/product-option.mdx +2 -2
- package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -1
- package/docs/reference/typescript-api/entities/product-variant.mdx +2 -2
- package/docs/reference/typescript-api/entities/product.mdx +2 -2
- package/docs/reference/typescript-api/entities/promotion.mdx +4 -4
- package/docs/reference/typescript-api/entities/province.mdx +1 -1
- package/docs/reference/typescript-api/entities/refund.mdx +1 -1
- package/docs/reference/typescript-api/entities/region.mdx +1 -1
- package/docs/reference/typescript-api/entities/role.mdx +1 -1
- package/docs/reference/typescript-api/entities/seller.mdx +1 -1
- package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/shipping-line.mdx +1 -1
- package/docs/reference/typescript-api/entities/shipping-method.mdx +4 -4
- package/docs/reference/typescript-api/entities/stock-level.mdx +1 -1
- package/docs/reference/typescript-api/entities/stock-location.mdx +1 -1
- package/docs/reference/typescript-api/entities/stock-movement.mdx +5 -5
- package/docs/reference/typescript-api/entities/surcharge.mdx +1 -1
- package/docs/reference/typescript-api/entities/tag.mdx +1 -1
- package/docs/reference/typescript-api/entities/tax-category.mdx +1 -1
- package/docs/reference/typescript-api/entities/tax-rate.mdx +1 -1
- package/docs/reference/typescript-api/entities/user.mdx +1 -1
- package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -1
- package/docs/reference/typescript-api/entities/zone.mdx +1 -1
- package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +2 -2
- package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx +2 -2
- package/docs/reference/typescript-api/events/event-bus.mdx +4 -4
- package/docs/reference/typescript-api/events/event-types.mdx +30 -30
- 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/asset-import-strategy.mdx +1 -1
- package/docs/reference/typescript-api/import-export/asset-importer.mdx +1 -1
- package/docs/reference/typescript-api/import-export/fast-importer-service.mdx +4 -4
- package/docs/reference/typescript-api/import-export/import-parser.mdx +5 -5
- package/docs/reference/typescript-api/import-export/importer.mdx +3 -3
- package/docs/reference/typescript-api/import-export/initial-data.mdx +3 -3
- package/docs/reference/typescript-api/import-export/populate.mdx +1 -1
- package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +8 -8
- package/docs/reference/typescript-api/job-queue/index.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +6 -6
- 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 +8 -8
- package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +6 -6
- 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/migration/generate-migration.mdx +1 -1
- package/docs/reference/typescript-api/migration/revert-last-migration.mdx +1 -1
- package/docs/reference/typescript-api/migration/run-migrations.mdx +1 -1
- package/docs/reference/typescript-api/orders/active-order-service.mdx +6 -6
- package/docs/reference/typescript-api/orders/active-order-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-code-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-interceptor.mdx +3 -3
- package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-process.mdx +4 -4
- package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
- 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-method-types.mdx +3 -3
- 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/plugin/vendure-plugin-metadata.mdx +4 -4
- package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -2
- package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +5 -5
- package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +1 -1
- package/docs/reference/typescript-api/promotions/promotion-action.mdx +22 -22
- package/docs/reference/typescript-api/promotions/promotion-condition.mdx +5 -5
- package/docs/reference/typescript-api/promotions/promotion-options.mdx +2 -2
- package/docs/reference/typescript-api/request/request-context-service.mdx +2 -2
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +4 -4
- package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +4 -4
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +3 -3
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +5 -5
- package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/order-calculator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +3 -3
- package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +2 -2
- package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +2 -2
- package/docs/reference/typescript-api/service-helpers/translator-service.mdx +1 -1
- package/docs/reference/typescript-api/services/administrator-service.mdx +6 -6
- package/docs/reference/typescript-api/services/asset-service.mdx +13 -13
- package/docs/reference/typescript-api/services/auth-service.mdx +4 -4
- package/docs/reference/typescript-api/services/channel-service.mdx +12 -12
- package/docs/reference/typescript-api/services/collection-service.mdx +20 -20
- package/docs/reference/typescript-api/services/country-service.mdx +7 -7
- package/docs/reference/typescript-api/services/customer-group-service.mdx +8 -8
- package/docs/reference/typescript-api/services/customer-service.mdx +24 -24
- package/docs/reference/typescript-api/services/entity-slug-service.mdx +1 -1
- package/docs/reference/typescript-api/services/facet-service.mdx +11 -11
- package/docs/reference/typescript-api/services/facet-value-service.mdx +12 -12
- package/docs/reference/typescript-api/services/fulfillment-service.mdx +4 -4
- package/docs/reference/typescript-api/services/global-settings-service.mdx +2 -2
- package/docs/reference/typescript-api/services/history-service.mdx +8 -8
- package/docs/reference/typescript-api/services/order-service.mdx +52 -52
- package/docs/reference/typescript-api/services/order-testing-service.mdx +2 -2
- package/docs/reference/typescript-api/services/payment-method-service.mdx +10 -10
- package/docs/reference/typescript-api/services/payment-service.mdx +7 -7
- package/docs/reference/typescript-api/services/product-option-group-service.mdx +5 -5
- package/docs/reference/typescript-api/services/product-option-service.mdx +5 -5
- package/docs/reference/typescript-api/services/product-service.mdx +13 -13
- package/docs/reference/typescript-api/services/product-variant-service.mdx +22 -22
- package/docs/reference/typescript-api/services/promotion-service.mdx +9 -9
- package/docs/reference/typescript-api/services/province-service.mdx +5 -5
- package/docs/reference/typescript-api/services/role-service.mdx +11 -11
- package/docs/reference/typescript-api/services/search-service.mdx +2 -2
- package/docs/reference/typescript-api/services/seller-service.mdx +3 -3
- package/docs/reference/typescript-api/services/session-service.mdx +8 -8
- package/docs/reference/typescript-api/services/settings-store-service.mdx +15 -15
- package/docs/reference/typescript-api/services/shipping-method-service.mdx +8 -8
- package/docs/reference/typescript-api/services/slug-service.mdx +1 -1
- package/docs/reference/typescript-api/services/stock-level-service.mdx +3 -3
- package/docs/reference/typescript-api/services/stock-location-service.mdx +7 -7
- package/docs/reference/typescript-api/services/stock-movement-service.mdx +7 -7
- package/docs/reference/typescript-api/services/tag-service.mdx +5 -5
- package/docs/reference/typescript-api/services/tax-category-service.mdx +5 -5
- package/docs/reference/typescript-api/services/tax-rate-service.mdx +6 -6
- package/docs/reference/typescript-api/services/user-service.mdx +12 -12
- package/docs/reference/typescript-api/services/zone-service.mdx +8 -8
- package/docs/reference/typescript-api/settings-store/settings-store-field-config.mdx +2 -2
- package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +1 -1
- package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +3 -3
- 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-line-assignment-strategy.mdx +1 -1
- package/docs/reference/typescript-api/shipping/shipping-options.mdx +5 -5
- package/docs/reference/typescript-api/state-machine/fsm.mdx +2 -2
- package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +4 -4
- package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +1 -1
- package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +2 -2
- package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -1
- package/docs/reference/typescript-api/testing/create-test-environment.mdx +1 -1
- package/docs/reference/typescript-api/testing/error-result-guard.mdx +1 -1
- package/docs/reference/typescript-api/testing/register-initializer.mdx +1 -1
- package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx +5 -5
- package/docs/reference/typescript-api/testing/test-db-initializer.mdx +3 -3
- package/docs/reference/typescript-api/testing/test-server.mdx +2 -2
- package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
- package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -2
- package/docs/reference/typescript-api/worker/vendure-worker.mdx +2 -2
- package/package.json +1 -1
- package/docs/reference/admin-ui-api/index.mdx +0 -4
- package/docs/reference/dashboard/index.mdx +0 -4
- package/docs/reference/graphql-api/admin/_index.mdx +0 -4
- package/docs/reference/graphql-api/shop/_index.mdx +0 -4
- package/docs/reference/typescript-api/_index.mdx +0 -4
|
@@ -71,7 +71,7 @@ class AdministratorEvent extends VendureEntityEvent<Administrator, Administrator
|
|
|
71
71
|
constructor(ctx: RequestContext, entity: Administrator, type: 'created' | 'updated' | 'deleted', input?: AdministratorInputTypes)
|
|
72
72
|
}
|
|
73
73
|
```
|
|
74
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
74
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a><<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>, AdministratorInputTypes></code>
|
|
75
75
|
|
|
76
76
|
|
|
77
77
|
|
|
@@ -127,7 +127,7 @@ class AssetEvent extends VendureEntityEvent<Asset, AssetInputTypes> {
|
|
|
127
127
|
asset: Asset
|
|
128
128
|
}
|
|
129
129
|
```
|
|
130
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
130
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a><<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>, AssetInputTypes></code>
|
|
131
131
|
|
|
132
132
|
|
|
133
133
|
|
|
@@ -197,7 +197,7 @@ class ChangeChannelEvent<T extends ChannelAware & VendureEntity> extends Vendure
|
|
|
197
197
|
|
|
198
198
|
### constructor
|
|
199
199
|
|
|
200
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: T, channelIds: <a href='/reference/typescript-api/common/id#id'>ID</a>[], type: 'assigned' | 'removed', entityType?: Type
|
|
200
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: T, channelIds: <a href='/reference/typescript-api/common/id#id'>ID</a>[], type: 'assigned' | 'removed', entityType?: Type<T>) => ChangeChannelEvent`} />
|
|
201
201
|
|
|
202
202
|
|
|
203
203
|
|
|
@@ -216,7 +216,7 @@ class ChannelEvent extends VendureEntityEvent<Channel, ChannelInputTypes> {
|
|
|
216
216
|
constructor(ctx: RequestContext, entity: Channel, type: 'created' | 'updated' | 'deleted', input?: ChannelInputTypes)
|
|
217
217
|
}
|
|
218
218
|
```
|
|
219
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
219
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a><<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>, ChannelInputTypes></code>
|
|
220
220
|
|
|
221
221
|
|
|
222
222
|
|
|
@@ -243,7 +243,7 @@ class CollectionEvent extends VendureEntityEvent<Collection, CollectionInputType
|
|
|
243
243
|
constructor(ctx: RequestContext, entity: Collection, type: 'created' | 'updated' | 'deleted', input?: CollectionInputTypes)
|
|
244
244
|
}
|
|
245
245
|
```
|
|
246
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
246
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a><<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>, CollectionInputTypes></code>
|
|
247
247
|
|
|
248
248
|
|
|
249
249
|
|
|
@@ -301,7 +301,7 @@ class CountryEvent extends VendureEntityEvent<Country, CountryInputTypes> {
|
|
|
301
301
|
constructor(ctx: RequestContext, entity: Country, type: 'created' | 'updated' | 'deleted', input?: CountryInputTypes)
|
|
302
302
|
}
|
|
303
303
|
```
|
|
304
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
304
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a><<a href='/reference/typescript-api/entities/country#country'>Country</a>, CountryInputTypes></code>
|
|
305
305
|
|
|
306
306
|
|
|
307
307
|
|
|
@@ -358,7 +358,7 @@ class CustomerAddressEvent extends VendureEntityEvent<Address, CustomerAddressIn
|
|
|
358
358
|
address: Address
|
|
359
359
|
}
|
|
360
360
|
```
|
|
361
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
361
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a><<a href='/reference/typescript-api/entities/address#address'>Address</a>, CustomerAddressInputTypes></code>
|
|
362
362
|
|
|
363
363
|
|
|
364
364
|
|
|
@@ -392,7 +392,7 @@ class CustomerEvent extends VendureEntityEvent<Customer, CustomerInputTypes> {
|
|
|
392
392
|
customer: Customer
|
|
393
393
|
}
|
|
394
394
|
```
|
|
395
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
395
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a><<a href='/reference/typescript-api/entities/customer#customer'>Customer</a>, CustomerInputTypes></code>
|
|
396
396
|
|
|
397
397
|
|
|
398
398
|
|
|
@@ -452,7 +452,7 @@ class CustomerGroupEvent extends VendureEntityEvent<CustomerGroup, CustomerGroup
|
|
|
452
452
|
constructor(ctx: RequestContext, entity: CustomerGroup, type: 'created' | 'updated' | 'deleted', input?: CustomerGroupInputTypes)
|
|
453
453
|
}
|
|
454
454
|
```
|
|
455
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
455
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a><<a href='/reference/typescript-api/entities/customer-group#customergroup'>CustomerGroup</a>, CustomerGroupInputTypes></code>
|
|
456
456
|
|
|
457
457
|
|
|
458
458
|
|
|
@@ -479,7 +479,7 @@ class FacetEvent extends VendureEntityEvent<Facet, FacetInputTypes> {
|
|
|
479
479
|
constructor(ctx: RequestContext, entity: Facet, type: 'created' | 'updated' | 'deleted', input?: FacetInputTypes)
|
|
480
480
|
}
|
|
481
481
|
```
|
|
482
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
482
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a><<a href='/reference/typescript-api/entities/facet#facet'>Facet</a>, FacetInputTypes></code>
|
|
483
483
|
|
|
484
484
|
|
|
485
485
|
|
|
@@ -506,7 +506,7 @@ class FacetValueEvent extends VendureEntityEvent<FacetValue, FacetValueInputType
|
|
|
506
506
|
constructor(ctx: RequestContext, entity: FacetValue, type: 'created' | 'updated' | 'deleted', input?: FacetValueInputTypes)
|
|
507
507
|
}
|
|
508
508
|
```
|
|
509
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
509
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a><<a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>, FacetValueInputTypes></code>
|
|
510
510
|
|
|
511
511
|
|
|
512
512
|
|
|
@@ -533,7 +533,7 @@ class FulfillmentEvent extends VendureEntityEvent<Fulfillment, CreateFulfillment
|
|
|
533
533
|
constructor(ctx: RequestContext, entity: Fulfillment, input?: CreateFulfillmentInput)
|
|
534
534
|
}
|
|
535
535
|
```
|
|
536
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
536
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a><<a href='/reference/typescript-api/entities/fulfillment#fulfillment'>Fulfillment</a>, CreateFulfillmentInput></code>
|
|
537
537
|
|
|
538
538
|
|
|
539
539
|
|
|
@@ -588,7 +588,7 @@ class GlobalSettingsEvent extends VendureEntityEvent<GlobalSettings, UpdateGloba
|
|
|
588
588
|
constructor(ctx: RequestContext, entity: GlobalSettings, input?: UpdateGlobalSettingsInput)
|
|
589
589
|
}
|
|
590
590
|
```
|
|
591
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
591
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a><<a href='/reference/typescript-api/entities/global-settings#globalsettings'>GlobalSettings</a>, UpdateGlobalSettingsInput></code>
|
|
592
592
|
|
|
593
593
|
|
|
594
594
|
|
|
@@ -616,7 +616,7 @@ class HistoryEntryEvent extends VendureEntityEvent<HistoryEntry, HistoryInput> {
|
|
|
616
616
|
constructor(ctx: RequestContext, entity: HistoryEntry, type: 'created' | 'updated' | 'deleted', historyType: 'order' | 'customer' | string, input?: HistoryInput)
|
|
617
617
|
}
|
|
618
618
|
```
|
|
619
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
619
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a><<a href='/reference/typescript-api/entities/history-entry#historyentry'>HistoryEntry</a>, HistoryInput></code>
|
|
620
620
|
|
|
621
621
|
|
|
622
622
|
|
|
@@ -787,7 +787,7 @@ class OrderEvent extends VendureEntityEvent<Order, OrderInputTypes> {
|
|
|
787
787
|
order: Order
|
|
788
788
|
}
|
|
789
789
|
```
|
|
790
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
790
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a><<a href='/reference/typescript-api/entities/order#order'>Order</a>, OrderInputTypes></code>
|
|
791
791
|
|
|
792
792
|
|
|
793
793
|
|
|
@@ -960,7 +960,7 @@ class PaymentMethodEvent extends VendureEntityEvent<PaymentMethod, PaymentMethod
|
|
|
960
960
|
constructor(ctx: RequestContext, entity: PaymentMethod, type: 'created' | 'updated' | 'deleted', input?: PaymentMethodInputTypes)
|
|
961
961
|
}
|
|
962
962
|
```
|
|
963
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
963
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a><<a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>, PaymentMethodInputTypes></code>
|
|
964
964
|
|
|
965
965
|
|
|
966
966
|
|
|
@@ -1045,7 +1045,7 @@ class ProductEvent extends VendureEntityEvent<Product, ProductInputTypes> {
|
|
|
1045
1045
|
product: Product
|
|
1046
1046
|
}
|
|
1047
1047
|
```
|
|
1048
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
1048
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a><<a href='/reference/typescript-api/entities/product#product'>Product</a>, ProductInputTypes></code>
|
|
1049
1049
|
|
|
1050
1050
|
|
|
1051
1051
|
|
|
@@ -1077,7 +1077,7 @@ class ProductOptionEvent extends VendureEntityEvent<ProductOption, ProductOption
|
|
|
1077
1077
|
constructor(ctx: RequestContext, entity: ProductOption, type: 'created' | 'updated' | 'deleted', input?: ProductOptionInputTypes)
|
|
1078
1078
|
}
|
|
1079
1079
|
```
|
|
1080
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
1080
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a><<a href='/reference/typescript-api/entities/product-option#productoption'>ProductOption</a>, ProductOptionInputTypes></code>
|
|
1081
1081
|
|
|
1082
1082
|
|
|
1083
1083
|
|
|
@@ -1134,7 +1134,7 @@ class ProductOptionGroupEvent extends VendureEntityEvent<
|
|
|
1134
1134
|
constructor(ctx: RequestContext, entity: ProductOptionGroup, type: 'created' | 'updated' | 'deleted', input?: ProductOptionGroupInputTypes)
|
|
1135
1135
|
}
|
|
1136
1136
|
```
|
|
1137
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
1137
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a>< <a href='/reference/typescript-api/entities/product-option-group#productoptiongroup'>ProductOptionGroup</a>, ProductOptionGroupInputTypes ></code>
|
|
1138
1138
|
|
|
1139
1139
|
|
|
1140
1140
|
|
|
@@ -1190,7 +1190,7 @@ class ProductVariantEvent extends VendureEntityEvent<ProductVariant[], ProductVa
|
|
|
1190
1190
|
variants: ProductVariant[]
|
|
1191
1191
|
}
|
|
1192
1192
|
```
|
|
1193
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
1193
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a><<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>[], ProductVariantInputTypes></code>
|
|
1194
1194
|
|
|
1195
1195
|
|
|
1196
1196
|
|
|
@@ -1225,7 +1225,7 @@ class ProductVariantPriceEvent extends VendureEntityEvent<
|
|
|
1225
1225
|
constructor(ctx: RequestContext, entity: ProductVariantPrice[], type: 'created' | 'updated' | 'deleted', input?: ProductVariantInputTypes)
|
|
1226
1226
|
}
|
|
1227
1227
|
```
|
|
1228
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
1228
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a>< <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>[], ProductVariantInputTypes ></code>
|
|
1229
1229
|
|
|
1230
1230
|
|
|
1231
1231
|
|
|
@@ -1253,7 +1253,7 @@ class PromotionEvent extends VendureEntityEvent<Promotion, PromotionInputTypes>
|
|
|
1253
1253
|
constructor(ctx: RequestContext, entity: Promotion, type: 'created' | 'updated' | 'deleted', input?: PromotionInputTypes)
|
|
1254
1254
|
}
|
|
1255
1255
|
```
|
|
1256
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
1256
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a><<a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>, PromotionInputTypes></code>
|
|
1257
1257
|
|
|
1258
1258
|
|
|
1259
1259
|
|
|
@@ -1280,7 +1280,7 @@ class ProvinceEvent extends VendureEntityEvent<Province, ProvinceInputTypes> {
|
|
|
1280
1280
|
constructor(ctx: RequestContext, entity: Province, type: 'created' | 'updated' | 'deleted', input?: ProvinceInputTypes)
|
|
1281
1281
|
}
|
|
1282
1282
|
```
|
|
1283
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
1283
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a><<a href='/reference/typescript-api/entities/province#province'>Province</a>, ProvinceInputTypes></code>
|
|
1284
1284
|
|
|
1285
1285
|
|
|
1286
1286
|
|
|
@@ -1389,7 +1389,7 @@ class RoleEvent extends VendureEntityEvent<Role, RoleInputTypes> {
|
|
|
1389
1389
|
constructor(ctx: RequestContext, entity: Role, type: 'created' | 'updated' | 'deleted', input?: RoleInputTypes)
|
|
1390
1390
|
}
|
|
1391
1391
|
```
|
|
1392
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
1392
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a><<a href='/reference/typescript-api/entities/role#role'>Role</a>, RoleInputTypes></code>
|
|
1393
1393
|
|
|
1394
1394
|
|
|
1395
1395
|
|
|
@@ -1443,7 +1443,7 @@ class SellerEvent extends VendureEntityEvent<Seller, SellerInputTypes> {
|
|
|
1443
1443
|
constructor(ctx: RequestContext, entity: Seller, type: 'created' | 'updated' | 'deleted', input?: SellerInputTypes)
|
|
1444
1444
|
}
|
|
1445
1445
|
```
|
|
1446
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
1446
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a><<a href='/reference/typescript-api/entities/seller#seller'>Seller</a>, SellerInputTypes></code>
|
|
1447
1447
|
|
|
1448
1448
|
|
|
1449
1449
|
|
|
@@ -1471,7 +1471,7 @@ class ShippingMethodEvent extends VendureEntityEvent<ShippingMethod, ShippingMet
|
|
|
1471
1471
|
constructor(ctx: RequestContext, entity: ShippingMethod, type: 'created' | 'updated' | 'deleted', input?: ShippingMethodInputTypes)
|
|
1472
1472
|
}
|
|
1473
1473
|
```
|
|
1474
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
1474
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a><<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>, ShippingMethodInputTypes></code>
|
|
1475
1475
|
|
|
1476
1476
|
|
|
1477
1477
|
|
|
@@ -1499,7 +1499,7 @@ class StockLocationEvent extends VendureEntityEvent<StockLocation, StockLocation
|
|
|
1499
1499
|
constructor(ctx: RequestContext, entity: StockLocation, type: 'created' | 'updated' | 'deleted', input?: StockLocationInputTypes)
|
|
1500
1500
|
}
|
|
1501
1501
|
```
|
|
1502
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
1502
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a><<a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>, StockLocationInputTypes></code>
|
|
1503
1503
|
|
|
1504
1504
|
|
|
1505
1505
|
|
|
@@ -1561,7 +1561,7 @@ class TaxCategoryEvent extends VendureEntityEvent<TaxCategory, TaxCategoryInputT
|
|
|
1561
1561
|
constructor(ctx: RequestContext, entity: TaxCategory, type: 'created' | 'updated' | 'deleted', input?: TaxCategoryInputTypes)
|
|
1562
1562
|
}
|
|
1563
1563
|
```
|
|
1564
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
1564
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a><<a href='/reference/typescript-api/entities/tax-category#taxcategory'>TaxCategory</a>, TaxCategoryInputTypes></code>
|
|
1565
1565
|
|
|
1566
1566
|
|
|
1567
1567
|
|
|
@@ -1589,7 +1589,7 @@ class TaxRateEvent extends VendureEntityEvent<TaxRate, TaxRateInputTypes> {
|
|
|
1589
1589
|
constructor(ctx: RequestContext, entity: TaxRate, type: 'created' | 'updated' | 'deleted', input?: TaxRateInputTypes)
|
|
1590
1590
|
}
|
|
1591
1591
|
```
|
|
1592
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
1592
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a><<a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a>, TaxRateInputTypes></code>
|
|
1593
1593
|
|
|
1594
1594
|
|
|
1595
1595
|
|
|
@@ -1644,7 +1644,7 @@ class ZoneEvent extends VendureEntityEvent<Zone, ZoneInputTypes> {
|
|
|
1644
1644
|
constructor(ctx: RequestContext, entity: Zone, type: 'created' | 'updated' | 'deleted', input?: ZoneInputTypes)
|
|
1645
1645
|
}
|
|
1646
1646
|
```
|
|
1647
|
-
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a
|
|
1647
|
+
* Extends: <code><a href='/reference/typescript-api/events/vendure-entity-event#vendureentityevent'>VendureEntityEvent</a><<a href='/reference/typescript-api/entities/zone#zone'>Zone</a>, ZoneInputTypes></code>
|
|
1648
1648
|
|
|
1649
1649
|
|
|
1650
1650
|
|
|
@@ -87,7 +87,7 @@ class FulfillmentHandler<T extends ConfigArgs = ConfigArgs> extends Configurable
|
|
|
87
87
|
constructor(config: FulfillmentHandlerConfig<T>)
|
|
88
88
|
}
|
|
89
89
|
```
|
|
90
|
-
* Extends: <code><a href='/reference/typescript-api/configurable-operation-def/#configurableoperationdef'>ConfigurableOperationDef</a
|
|
90
|
+
* Extends: <code><a href='/reference/typescript-api/configurable-operation-def/#configurableoperationdef'>ConfigurableOperationDef</a><T></code>
|
|
91
91
|
|
|
92
92
|
|
|
93
93
|
|
|
@@ -95,7 +95,7 @@ class FulfillmentHandler<T extends ConfigArgs = ConfigArgs> extends Configurable
|
|
|
95
95
|
|
|
96
96
|
### constructor
|
|
97
97
|
|
|
98
|
-
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/fulfillment/fulfillment-handler#fulfillmenthandlerconfig'>FulfillmentHandlerConfig</a
|
|
98
|
+
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/fulfillment/fulfillment-handler#fulfillmenthandlerconfig'>FulfillmentHandlerConfig</a><T>) => FulfillmentHandler`} />
|
|
99
99
|
|
|
100
100
|
|
|
101
101
|
|
|
@@ -115,7 +115,7 @@ interface FulfillmentHandlerConfig<T extends ConfigArgs> extends ConfigurableOpe
|
|
|
115
115
|
onFulfillmentTransition?: OnTransitionStartFn<FulfillmentState, FulfillmentTransitionData>;
|
|
116
116
|
}
|
|
117
117
|
```
|
|
118
|
-
* Extends: <code><a href='/reference/typescript-api/configurable-operation-def/configurable-operation-def-options#configurableoperationdefoptions'>ConfigurableOperationDefOptions</a
|
|
118
|
+
* Extends: <code><a href='/reference/typescript-api/configurable-operation-def/configurable-operation-def-options#configurableoperationdefoptions'>ConfigurableOperationDefOptions</a><T></code>
|
|
119
119
|
|
|
120
120
|
|
|
121
121
|
|
|
@@ -123,7 +123,7 @@ interface FulfillmentHandlerConfig<T extends ConfigArgs> extends ConfigurableOpe
|
|
|
123
123
|
|
|
124
124
|
### createFulfillment
|
|
125
125
|
|
|
126
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/fulfillment/fulfillment-handler#createfulfillmentfn'>CreateFulfillmentFn</a
|
|
126
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/fulfillment/fulfillment-handler#createfulfillmentfn'>CreateFulfillmentFn</a><T>`} />
|
|
127
127
|
|
|
128
128
|
Invoked when the `addFulfillmentToOrder` mutation is executed with this handler selected.
|
|
129
129
|
|
|
@@ -131,7 +131,7 @@ If an Error is thrown from within this function, no Fulfillment is created and t
|
|
|
131
131
|
result will be returned.
|
|
132
132
|
### onFulfillmentTransition
|
|
133
133
|
|
|
134
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a
|
|
134
|
+
<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>>`} />
|
|
135
135
|
|
|
136
136
|
This allows the handler to intercept state transitions of the created Fulfillment. This works much in the
|
|
137
137
|
same way as the <a href='/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess'>FulfillmentProcess</a> `onTransitionStart` method (i.e. returning `false` or
|
|
@@ -47,22 +47,22 @@ interface FulfillmentProcess<State extends keyof CustomFulfillmentStates | strin
|
|
|
47
47
|
|
|
48
48
|
### transitions
|
|
49
49
|
|
|
50
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a
|
|
50
|
+
<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>>`} />
|
|
51
51
|
|
|
52
52
|
|
|
53
53
|
### onTransitionStart
|
|
54
54
|
|
|
55
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a
|
|
55
|
+
<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>>`} />
|
|
56
56
|
|
|
57
57
|
|
|
58
58
|
### onTransitionEnd
|
|
59
59
|
|
|
60
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a
|
|
60
|
+
<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>>`} />
|
|
61
61
|
|
|
62
62
|
|
|
63
63
|
### onTransitionError
|
|
64
64
|
|
|
65
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a
|
|
65
|
+
<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>>`} />
|
|
66
66
|
|
|
67
67
|
|
|
68
68
|
|
|
@@ -36,7 +36,7 @@ interface AssetImportStrategy extends InjectableStrategy {
|
|
|
36
36
|
|
|
37
37
|
### getStreamFromPath
|
|
38
38
|
|
|
39
|
-
<MemberInfo kind="method" type={`(assetPath: string) => Readable | Promise
|
|
39
|
+
<MemberInfo kind="method" type={`(assetPath: string) => Readable | Promise<Readable>`} />
|
|
40
40
|
|
|
41
41
|
Given an asset path, this method should return a Stream of file data. This could
|
|
42
42
|
e.g. be read from a file system or fetch from a remote location.
|
|
@@ -22,7 +22,7 @@ class AssetImporter {
|
|
|
22
22
|
|
|
23
23
|
### getAssets
|
|
24
24
|
|
|
25
|
-
<MemberInfo kind="method" type={`(assetPaths: string[], ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise
|
|
25
|
+
<MemberInfo kind="method" type={`(assetPaths: string[], ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<{ assets: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[]; errors: string[] }>`} />
|
|
26
26
|
|
|
27
27
|
Creates Asset entities for the given paths, using the assetMap cache to prevent the
|
|
28
28
|
creation of duplicates.
|
|
@@ -38,17 +38,17 @@ Passing a `channel` argument means that Products and ProductVariants will be ass
|
|
|
38
38
|
to that Channel.
|
|
39
39
|
### createProduct
|
|
40
40
|
|
|
41
|
-
<MemberInfo kind="method" type={`(input: CreateProductInput) => Promise
|
|
41
|
+
<MemberInfo kind="method" type={`(input: CreateProductInput) => Promise<<a href='/reference/typescript-api/common/id#id'>ID</a>>`} />
|
|
42
42
|
|
|
43
43
|
|
|
44
44
|
### createProductOptionGroup
|
|
45
45
|
|
|
46
|
-
<MemberInfo kind="method" type={`(input: CreateProductOptionGroupInput) => Promise
|
|
46
|
+
<MemberInfo kind="method" type={`(input: CreateProductOptionGroupInput) => Promise<<a href='/reference/typescript-api/common/id#id'>ID</a>>`} />
|
|
47
47
|
|
|
48
48
|
|
|
49
49
|
### createProductOption
|
|
50
50
|
|
|
51
|
-
<MemberInfo kind="method" type={`(input: CreateProductOptionInput) => Promise
|
|
51
|
+
<MemberInfo kind="method" type={`(input: CreateProductOptionInput) => Promise<<a href='/reference/typescript-api/common/id#id'>ID</a>>`} />
|
|
52
52
|
|
|
53
53
|
|
|
54
54
|
### addOptionGroupToProduct
|
|
@@ -58,7 +58,7 @@ to that Channel.
|
|
|
58
58
|
|
|
59
59
|
### createProductVariant
|
|
60
60
|
|
|
61
|
-
<MemberInfo kind="method" type={`(input: CreateProductVariantInput) => Promise
|
|
61
|
+
<MemberInfo kind="method" type={`(input: CreateProductVariantInput) => Promise<<a href='/reference/typescript-api/common/id#id'>ID</a>>`} />
|
|
62
62
|
|
|
63
63
|
|
|
64
64
|
|
|
@@ -21,7 +21,7 @@ class ImportParser {
|
|
|
21
21
|
|
|
22
22
|
### parseProducts
|
|
23
23
|
|
|
24
|
-
<MemberInfo kind="method" type={`(input: string | Stream, mainLanguage: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a> = this.configService.defaultLanguageCode) => Promise
|
|
24
|
+
<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>>>`} />
|
|
25
25
|
|
|
26
26
|
Parses the contents of the [product import CSV file](/guides/developer-guide/importing-data/#product-import-format) and
|
|
27
27
|
returns a data structure which can then be used to populate Vendure using the <a href='/reference/typescript-api/import-export/fast-importer-service#fastimporterservice'>FastImporterService</a>.
|
|
@@ -51,7 +51,7 @@ interface ParsedOptionGroup {
|
|
|
51
51
|
|
|
52
52
|
### translations
|
|
53
53
|
|
|
54
|
-
<MemberInfo kind="property" type={`Array
|
|
54
|
+
<MemberInfo kind="property" type={`Array<{ languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>; name: string; values: string[]; }>`} />
|
|
55
55
|
|
|
56
56
|
|
|
57
57
|
|
|
@@ -80,7 +80,7 @@ interface ParsedFacet {
|
|
|
80
80
|
|
|
81
81
|
### translations
|
|
82
82
|
|
|
83
|
-
<MemberInfo kind="property" type={`Array
|
|
83
|
+
<MemberInfo kind="property" type={`Array<{ languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>; facet: string; value: string; }>`} />
|
|
84
84
|
|
|
85
85
|
|
|
86
86
|
|
|
@@ -153,7 +153,7 @@ interface ParsedProductVariant {
|
|
|
153
153
|
|
|
154
154
|
### translations
|
|
155
155
|
|
|
156
|
-
<MemberInfo kind="property" type={`Array
|
|
156
|
+
<MemberInfo kind="property" type={`Array<{ languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>; optionValues: string[]; customFields: { [name: string]: string; }; }>`} />
|
|
157
157
|
|
|
158
158
|
|
|
159
159
|
|
|
@@ -204,7 +204,7 @@ interface ParsedProduct {
|
|
|
204
204
|
|
|
205
205
|
### translations
|
|
206
206
|
|
|
207
|
-
<MemberInfo kind="property" type={`Array
|
|
207
|
+
<MemberInfo kind="property" type={`Array<{ languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>; name: string; slug: string; description: string; customFields: { [name: string]: string; }; }>`} />
|
|
208
208
|
|
|
209
209
|
|
|
210
210
|
|
|
@@ -27,7 +27,7 @@ class Importer {
|
|
|
27
27
|
|
|
28
28
|
### parseAndImport
|
|
29
29
|
|
|
30
|
-
<MemberInfo kind="method" type={`(input: string | Stream, ctxOrLanguageCode: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>, reportProgress: boolean = false) => Observable
|
|
30
|
+
<MemberInfo kind="method" type={`(input: string | Stream, ctxOrLanguageCode: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>, reportProgress: boolean = false) => Observable<ImportProgress>`} />
|
|
31
31
|
|
|
32
32
|
Parses the contents of the [product import CSV file](/guides/developer-guide/importing-data/#product-import-format) and imports
|
|
33
33
|
the resulting Product & ProductVariants, as well as any associated Assets, Facets & FacetValues.
|
|
@@ -35,12 +35,12 @@ the resulting Product & ProductVariants, as well as any associated Assets, Facet
|
|
|
35
35
|
The `ctxOrLanguageCode` argument is used to specify the languageCode to be used when creating the Products.
|
|
36
36
|
### importProducts
|
|
37
37
|
|
|
38
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, rows: <a href='/reference/typescript-api/import-export/import-parser#parsedproductwithvariants'>ParsedProductWithVariants</a>[], onProgress: OnProgressFn) => Promise
|
|
38
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, rows: <a href='/reference/typescript-api/import-export/import-parser#parsedproductwithvariants'>ParsedProductWithVariants</a>[], onProgress: OnProgressFn) => Promise<string[]>`} />
|
|
39
39
|
|
|
40
40
|
Imports the products specified in the rows object. Return an array of error messages.
|
|
41
41
|
### getFacetValueIds
|
|
42
42
|
|
|
43
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, facets: <a href='/reference/typescript-api/import-export/import-parser#parsedfacet'>ParsedFacet</a>[], languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>) => Promise
|
|
43
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, facets: <a href='/reference/typescript-api/import-export/import-parser#parsedfacet'>ParsedFacet</a>[], languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>) => Promise<<a href='/reference/typescript-api/common/id#id'>ID</a>[]>`} />
|
|
44
44
|
|
|
45
45
|
|
|
46
46
|
### processCustomFieldValues
|
|
@@ -47,17 +47,17 @@ interface InitialData {
|
|
|
47
47
|
|
|
48
48
|
### taxRates
|
|
49
49
|
|
|
50
|
-
<MemberInfo kind="property" type={`Array
|
|
50
|
+
<MemberInfo kind="property" type={`Array<{ name: string; percentage: number }>`} />
|
|
51
51
|
|
|
52
52
|
|
|
53
53
|
### shippingMethods
|
|
54
54
|
|
|
55
|
-
<MemberInfo kind="property" type={`Array
|
|
55
|
+
<MemberInfo kind="property" type={`Array<{ name: string; price: number; taxRate?: number }>`} />
|
|
56
56
|
|
|
57
57
|
|
|
58
58
|
### paymentMethods
|
|
59
59
|
|
|
60
|
-
<MemberInfo kind="property" type={`Array
|
|
60
|
+
<MemberInfo kind="property" type={`Array<{ name: string; handler: ConfigurableOperationInput }>`} />
|
|
61
61
|
|
|
62
62
|
|
|
63
63
|
### collections
|
|
@@ -129,7 +129,7 @@ class DefaultJobQueuePlugin {
|
|
|
129
129
|
|
|
130
130
|
### init
|
|
131
131
|
|
|
132
|
-
<MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueoptions'>DefaultJobQueueOptions</a>) => Type
|
|
132
|
+
<MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueoptions'>DefaultJobQueueOptions</a>) => Type<<a href='/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin'>DefaultJobQueuePlugin</a>>`} />
|
|
133
133
|
|
|
134
134
|
|
|
135
135
|
|
|
@@ -170,7 +170,7 @@ interface DefaultJobQueueOptions {
|
|
|
170
170
|
|
|
171
171
|
### pollInterval
|
|
172
172
|
|
|
173
|
-
<MemberInfo kind="property" type={`number | ((queueName: string)
|
|
173
|
+
<MemberInfo kind="property" type={`number | ((queueName: string) => number)`} default={`200`} />
|
|
174
174
|
|
|
175
175
|
The interval in ms between polling the database for new jobs. If many job queues
|
|
176
176
|
are active, the polling may cause undue load on the database, in which case this value
|
|
@@ -182,12 +182,12 @@ should be increased to e.g. 1000.
|
|
|
182
182
|
How many jobs from a given queue to process concurrently.
|
|
183
183
|
### backoffStrategy
|
|
184
184
|
|
|
185
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/job-queue/types#backoffstrategy'>BackoffStrategy</a>`} default={`()
|
|
185
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/job-queue/types#backoffstrategy'>BackoffStrategy</a>`} default={`() => 1000`} />
|
|
186
186
|
|
|
187
187
|
The strategy used to decide how long to wait before retrying a failed job.
|
|
188
188
|
### setRetries
|
|
189
189
|
|
|
190
|
-
<MemberInfo kind="property" type={`(queueName: string, job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>)
|
|
190
|
+
<MemberInfo kind="property" type={`(queueName: string, job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>) => number`} />
|
|
191
191
|
|
|
192
192
|
When a job is added to the JobQueue using `JobQueue.add()`, the calling
|
|
193
193
|
code may specify the number of retries in case of failure. This option allows
|
|
@@ -234,7 +234,7 @@ debugging and auditing purposes, but if you have a lot of jobs, it may be
|
|
|
234
234
|
desirable to limit the number of records in the database.
|
|
235
235
|
### cleanJobsSchedule
|
|
236
236
|
|
|
237
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtaskconfig'>ScheduledTaskConfig</a>['schedule']`} default={`cron
|
|
237
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtaskconfig'>ScheduledTaskConfig</a>['schedule']`} default={`cron => cron.every(2).hours()`} since="3.3.0" />
|
|
238
238
|
|
|
239
239
|
The schedule for the "clean-jobs" task. This task will run periodically to clean up
|
|
240
240
|
old jobs from the database. The schedule can be a cron expression or a function
|
|
@@ -36,17 +36,17 @@ class InMemoryJobBufferStorageStrategy implements JobBufferStorageStrategy {
|
|
|
36
36
|
|
|
37
37
|
### add
|
|
38
38
|
|
|
39
|
-
<MemberInfo kind="method" type={`(bufferId: string, job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>) => Promise
|
|
39
|
+
<MemberInfo kind="method" type={`(bufferId: string, job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>) => Promise<<a href='/reference/typescript-api/job-queue/job#job'>Job</a>>`} />
|
|
40
40
|
|
|
41
41
|
|
|
42
42
|
### bufferSize
|
|
43
43
|
|
|
44
|
-
<MemberInfo kind="method" type={`(bufferIds?: string[]) => Promise
|
|
44
|
+
<MemberInfo kind="method" type={`(bufferIds?: string[]) => Promise<{ [bufferId: string]: number }>`} />
|
|
45
45
|
|
|
46
46
|
|
|
47
47
|
### flush
|
|
48
48
|
|
|
49
|
-
<MemberInfo kind="method" type={`(bufferIds?: string[]) => Promise
|
|
49
|
+
<MemberInfo kind="method" type={`(bufferIds?: string[]) => Promise<{ [bufferId: string]: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>[] }>`} />
|
|
50
50
|
|
|
51
51
|
|
|
52
52
|
|