npm - @vendure/docs - Versions diffs - 0.0.0-202601161707 → 0.0.0-20260116211406 - Mend

@vendure/docs 0.0.0-202601161707 → 0.0.0-20260116211406

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (663) hide show

package/docs/reference/typescript-api/auth/authentication-strategy.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "AuthenticationStrategy"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## AuthenticationStrategy
@@ -66,7 +65,7 @@ defineInputType() {
 assuming the strategy name is "my_auth", then the resulting call to `authenticate`
 would look like:
-```graphql
+```GraphQL
 authenticate(input: {
   my_auth: {
     token: "foo"

package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "BcryptPasswordHashingStrategy"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## BcryptPasswordHashingStrategy

package/docs/reference/typescript-api/auth/cookie-options.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "CookieOptions"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## CookieOptions

package/docs/reference/typescript-api/auth/default-password-validation-strategy.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "DefaultPasswordValidationStrategy"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## DefaultPasswordValidationStrategy

package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "DefaultSessionCacheStrategy"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## DefaultSessionCacheStrategy

package/docs/reference/typescript-api/auth/default-verification-token-strategy.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "DefaultVerificationTokenStrategy"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## DefaultVerificationTokenStrategy

package/docs/reference/typescript-api/auth/external-authentication-service.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "ExternalAuthenticationService"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## ExternalAuthenticationService

package/docs/reference/typescript-api/auth/in-memory-session-cache-strategy.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "InMemorySessionCacheStrategy"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## InMemorySessionCacheStrategy

package/docs/reference/typescript-api/auth/index.mdx CHANGED Viewed

@@ -2,4 +2,3 @@
 title: "Auth"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->

package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "NativeAuthenticationStrategy"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## NativeAuthenticationStrategy

package/docs/reference/typescript-api/auth/noop-session-cache-strategy.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "NoopSessionCacheStrategy"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## NoopSessionCacheStrategy

package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "PasswordHashingStrategy"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## PasswordHashingStrategy

package/docs/reference/typescript-api/auth/password-validation-strategy.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "PasswordValidationStrategy"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## PasswordValidationStrategy

package/docs/reference/typescript-api/auth/permission-definition.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "PermissionDefinition"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## PermissionDefinition

package/docs/reference/typescript-api/auth/session-cache-strategy.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "SessionCacheStrategy"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## SessionCacheStrategy

package/docs/reference/typescript-api/auth/superadmin-credentials.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "SuperadminCredentials"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## SuperadminCredentials

package/docs/reference/typescript-api/auth/verification-token-strategy.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "VerificationTokenStrategy"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## VerificationTokenStrategy

package/docs/reference/typescript-api/cache/cache-config.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "CacheConfig"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## CacheConfig

package/docs/reference/typescript-api/cache/cache-service.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "CacheService"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## CacheService

package/docs/reference/typescript-api/cache/cache-strategy.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "CacheStrategy"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## CacheStrategy

package/docs/reference/typescript-api/cache/default-cache-plugin.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "DefaultCachePlugin"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## DefaultCachePlugin

package/docs/reference/typescript-api/cache/index.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "Cache"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## Cache

package/docs/reference/typescript-api/cache/redis-cache-plugin.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "RedisCachePlugin"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## RedisCachePlugin
@@ -15,7 +14,7 @@ replacement for the <a href='/reference/typescript-api/cache/default-cache-plugi
 Note: To use this plugin, you need to manually install the `ioredis` package:
-```bash
+```shell
 npm install ioredis@^5.3.2
 ```

package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "RedisCacheStrategy"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## RedisCacheStrategy
@@ -14,7 +13,7 @@ This is a high-performance cache strategy which is suitable for production use.
 Note: To use this strategy, you need to manually install the `ioredis` package:
-```bash
+```shell
 npm install ioredis@^5.3.2
 ```

package/docs/reference/typescript-api/cache/request-context-cache-service.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "RequestContextCacheService"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## RequestContextCacheService

package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "SelfRefreshingCache"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## SelfRefreshingCache

package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "SqlCacheStrategy"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## SqlCacheStrategy

package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "AdminUiAppConfig"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## AdminUiAppConfig

package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "AdminUiAppDevModeConfig"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## AdminUiAppDevModeConfig

package/docs/reference/typescript-api/common/admin-ui/admin-ui-config.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "AdminUiConfig"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## AdminUiConfig

package/docs/reference/typescript-api/common/admin-ui/index.mdx CHANGED Viewed

@@ -2,4 +2,3 @@
 title: "Admin Ui"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->

package/docs/reference/typescript-api/common/async-queue.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "AsyncQueue"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## AsyncQueue

package/docs/reference/typescript-api/common/bootstrap.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "Bootstrap"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## bootstrap

package/docs/reference/typescript-api/common/currency-code.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "CurrencyCode"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## CurrencyCode

package/docs/reference/typescript-api/common/entity-relation-paths.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "EntityRelationPaths"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## EntityRelationPaths

package/docs/reference/typescript-api/common/i18n-service.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "I18nService"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## I18nService

package/docs/reference/typescript-api/common/id.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "ID"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## ID

package/docs/reference/typescript-api/common/index.mdx CHANGED Viewed

@@ -2,4 +2,3 @@
 title: "Common"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->

package/docs/reference/typescript-api/common/injectable-strategy.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "InjectableStrategy"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## InjectableStrategy

package/docs/reference/typescript-api/common/injector.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "Injector"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## Injector

package/docs/reference/typescript-api/common/job-state.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "JobState"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## JobState

package/docs/reference/typescript-api/common/json-compatible.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "JsonCompatible"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## JsonCompatible

package/docs/reference/typescript-api/common/language-code.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "LanguageCode"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## LanguageCode

package/docs/reference/typescript-api/common/middleware.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "Middleware"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## Middleware

package/docs/reference/typescript-api/common/paginated-list.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "PaginatedList"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## PaginatedList

package/docs/reference/typescript-api/common/permission.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "Permission"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## Permission

package/docs/reference/typescript-api/common/price-calculation-result.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "PriceCalculationResult"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## PriceCalculationResult

package/docs/reference/typescript-api/common/process-context.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "ProcessContext"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## ProcessContext

package/docs/reference/typescript-api/common/vendure_version.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "VENDURE_VERSION"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## VENDURE_VERSION

package/docs/reference/typescript-api/configurable-operation-def/config-arg-type.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "ConfigArgType"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## ConfigArgType

package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "ConfigArgs"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## ConfigArgs

package/docs/reference/typescript-api/configurable-operation-def/configurable-operation-def-options.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "ConfigurableOperationDefOptions"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## ConfigurableOperationDefOptions

package/docs/reference/typescript-api/configurable-operation-def/default-form-component-id.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "DefaultFormComponentId"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## DefaultFormComponentId

package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "DefaultFormConfigHash"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## DefaultFormConfigHash

package/docs/reference/typescript-api/configurable-operation-def/index.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "ConfigurableOperationDef"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## ConfigurableOperationDef

package/docs/reference/typescript-api/configurable-operation-def/localized-string-array.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "LocalizedStringArray"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## LocalizedStringArray

package/docs/reference/typescript-api/configuration/api-options.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "ApiOptions"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## ApiOptions

package/docs/reference/typescript-api/configuration/collection-filter.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "CollectionFilter"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## CollectionFilter

package/docs/reference/typescript-api/configuration/default-config.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "DefaultConfig"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## defaultConfig

package/docs/reference/typescript-api/configuration/default-slug-strategy.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "DefaultSlugStrategy"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## DefaultSlugStrategy

package/docs/reference/typescript-api/configuration/entity-duplicator.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "EntityDuplicator"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## EntityDuplicator

package/docs/reference/typescript-api/configuration/entity-id-decorator.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "EntityId Decorator"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## EntityId

package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "EntityIdStrategy"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## AutoIncrementIdStrategy

package/docs/reference/typescript-api/configuration/entity-options.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "EntityOptions"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## EntityOptions

package/docs/reference/typescript-api/configuration/index.mdx CHANGED Viewed

@@ -2,4 +2,3 @@
 title: "Configuration"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->

package/docs/reference/typescript-api/configuration/merge-config.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "MergeConfig"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## mergeConfig

package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "ProductVariantPriceSelectionStrategy"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## ProductVariantPriceSelectionStrategy

package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx CHANGED Viewed

@@ -2,7 +2,6 @@
 title: "ProductVariantPriceUpdateStrategy"
 generated: true
 ---
-<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
 ## ProductVariantPriceUpdateStrategy