npm - @vendure/docs - Versions diffs - 0.0.0-202601211552 → 0.0.0-202601211609 - Mend

@vendure/docs 0.0.0-202601211552 → 0.0.0-202601211609

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 (358) hide show

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

@@ -45,22 +45,22 @@ class DefaultSessionCacheStrategy implements SessionCacheStrategy {
 ### set
-<MemberInfo kind="method" type={`(session: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>) => Promise<void>`}   />
+<MemberInfo kind="method" type={`(session: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>) => `Promise<void>``}   />
 ### get
-<MemberInfo kind="method" type={`(sessionToken: string) => Promise<<a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a> | undefined>`}   />
+<MemberInfo kind="method" type={`(sessionToken: string) => `Promise<`<a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>` | undefined>``}   />
 ### delete
-<MemberInfo kind="method" type={`(sessionToken: string) => void | Promise<void>`}   />
+<MemberInfo kind="method" type={`(sessionToken: string) => `void | Promise<void>``}   />
 ### clear
-<MemberInfo kind="method" type={`() => Promise<void>`}   />
+<MemberInfo kind="method" type={`() => `Promise<void>``}   />

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

@@ -46,7 +46,7 @@ class ExternalAuthenticationService {
 ### findCustomerUser
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, strategy: string, externalIdentifier: string, checkCurrentChannelOnly:  = true) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | undefined>`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, strategy: string, externalIdentifier: string, checkCurrentChannelOnly:  = true) => `Promise<`<a href='/reference/typescript-api/entities/user#user'>User</a>` | undefined>``}   />
 Looks up a User based on their identifier from an external authentication
 provider, ensuring this User is associated with a Customer account.
@@ -56,13 +56,13 @@ By passing `false` as the `checkCurrentChannelOnly` argument, _all_ channels
 will be checked.
 ### findAdministratorUser
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, strategy: string, externalIdentifier: string) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | undefined>`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, strategy: string, externalIdentifier: string) => `Promise<`<a href='/reference/typescript-api/entities/user#user'>User</a>` | undefined>``}   />
 Looks up a User based on their identifier from an external authentication
 provider, ensuring this User is associated with an Administrator account.
 ### createCustomerAndUser
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, config: {             strategy: string;             externalIdentifier: string;             emailAddress: string;             firstName: string;             lastName: string;             verified?: boolean;         }) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a>>`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, config: {             strategy: string;             externalIdentifier: string;             emailAddress: string;             firstName: string;             lastName: string;             verified?: boolean;         }) => `Promise<`<a href='/reference/typescript-api/entities/user#user'>User</a>`>``}   />
 If a customer has been successfully authenticated by an external authentication provider, yet cannot
 be found using `findCustomerUser`, then we need to create a new User and
@@ -77,12 +77,12 @@ be found using `findAdministratorUser`, then we need to create a new User and
 Administrator record in Vendure for that user.
 ### findUser
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, strategy: string, externalIdentifier: string) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | undefined>`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, strategy: string, externalIdentifier: string) => `Promise<`<a href='/reference/typescript-api/entities/user#user'>User</a>` | undefined>``}   />
 ### createUser
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, config: {             strategy: string;             externalIdentifier: string;         }) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a>>`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, config: {             strategy: string;             externalIdentifier: string;         }) => `Promise<`<a href='/reference/typescript-api/entities/user#user'>User</a>`>``}   />
 Looks up a User based on their identifier from an external authentication
 provider. Creates the user if does not exist. Unlike `findCustomerUser` and `findAdministratorUser`,

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

@@ -40,12 +40,12 @@ class NativeAuthenticationStrategy implements AuthenticationStrategy<NativeAuthe
 ### authenticate
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, data: NativeAuthenticationData) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | false>`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, data: NativeAuthenticationData) => `Promise<`<a href='/reference/typescript-api/entities/user#user'>User</a>` | false>``}   />
 ### verifyUserPassword
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, userId: <a href='/reference/typescript-api/common/id#id'>ID</a>, password: string) => Promise<boolean>`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, userId: <a href='/reference/typescript-api/common/id#id'>ID</a>, password: string) => `Promise<boolean>``}   />

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

@@ -27,12 +27,12 @@ interface PasswordHashingStrategy extends InjectableStrategy {
 ### hash
-<MemberInfo kind="method" type={`(plaintext: string) => Promise<string>`}   />
+<MemberInfo kind="method" type={`(plaintext: string) => `Promise<string>``}   />
 ### check
-<MemberInfo kind="method" type={`(plaintext: string, hash: string) => Promise<boolean>`}   />
+<MemberInfo kind="method" type={`(plaintext: string, hash: string) => `Promise<boolean>``}   />

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

@@ -27,7 +27,7 @@ interface PasswordValidationStrategy extends InjectableStrategy {
 ### validate
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, password: string) => Promise<boolean | string> | boolean | string`}  since="1.5.0"  />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, password: string) => `Promise<boolean | string> | boolean | string``}  since="1.5.0"  />
 Validates a password submitted during account registration or when a customer updates their password.
 The method should resolve to `true` if the password is acceptable. If not, it should return `false` or

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

@@ -109,7 +109,7 @@ class CrudPermissionDefinition extends PermissionDefinition {
 ### constructor
-<MemberInfo kind="method" type={`(name: string, descriptionFn?: (operation: 'create' | 'read' | 'update' | 'delete') => string) => CrudPermissionDefinition`}   />
+<MemberInfo kind="method" type={`(name: string, descriptionFn?: `(operation: 'create' | 'read' | 'update' | 'delete') => string`) => CrudPermissionDefinition`}   />
 ### Create
@@ -191,7 +191,7 @@ class RwPermissionDefinition extends PermissionDefinition {
 ### constructor
-<MemberInfo kind="method" type={`(name: string, descriptionFn?: (operation: 'read' | 'write') => string) => RwPermissionDefinition`}   />
+<MemberInfo kind="method" type={`(name: string, descriptionFn?: `(operation: 'read' | 'write') => string`) => RwPermissionDefinition`}   />
 ### Read

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

@@ -133,24 +133,24 @@ interface SessionCacheStrategy extends InjectableStrategy {
 ### set
-<MemberInfo kind="method" type={`(session: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>) => void | Promise<void>`}   />
+<MemberInfo kind="method" type={`(session: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>) => `void | Promise<void>``}   />
 Store the session in the cache. When caching a session, the data
 should not be modified apart from performing any transforms needed to
 get it into a state to be stored, e.g. JSON.stringify().
 ### get
-<MemberInfo kind="method" type={`(sessionToken: string) => <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a> | undefined | Promise<<a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a> | undefined>`}   />
+<MemberInfo kind="method" type={`(sessionToken: string) => <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>` | undefined | Promise<`<a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>` | undefined>``}   />
 Retrieve the session from the cache
 ### delete
-<MemberInfo kind="method" type={`(sessionToken: string) => void | Promise<void>`}   />
+<MemberInfo kind="method" type={`(sessionToken: string) => `void | Promise<void>``}   />
 Delete a session from the cache
 ### clear
-<MemberInfo kind="method" type={`() => void | Promise<void>`}   />
+<MemberInfo kind="method" type={`() => `void | Promise<void>``}   />
 Clear the entire cache

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

@@ -27,12 +27,12 @@ interface VerificationTokenStrategy extends InjectableStrategy {
 ### generateVerificationToken
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<string> | string`}  since="3.2.0"  />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => `Promise<string> | string``}  since="3.2.0"  />
 Generates a verification token.
 ### verifyVerificationToken
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, token: string) => Promise<boolean> | boolean`}  since="3.2.0"  />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, token: string) => `Promise<boolean> | boolean``}  since="3.2.0"  />
 Checks the validity of a verification token.

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

@@ -17,7 +17,7 @@ interface CacheConfig {
 ### getKey
-<MemberInfo kind="property" type={`(id: string | number) => string`}   />
+<MemberInfo kind="property" type={``(id: string | number) => string``}   />
 A function which generates a cache key from the given id.
 This key will be used to store the value in the cache.

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

@@ -43,13 +43,13 @@ The `Cache` instance provides a convenience wrapper around the `CacheService`
 methods.
 ### get
-<MemberInfo kind="method" type={`(key: string) => Promise<T | undefined>`}   />
+<MemberInfo kind="method" type={`(key: string) => `Promise<T | undefined>``}   />
 Gets an item from the cache, or returns undefined if the key is not found, or the
 item has expired.
 ### set
-<MemberInfo kind="method" type={`(key: string, value: T, options?: <a href='/reference/typescript-api/cache/cache-strategy#setcachekeyoptions'>SetCacheKeyOptions</a>) => Promise<void>`}   />
+<MemberInfo kind="method" type={`(key: string, value: T, options?: <a href='/reference/typescript-api/cache/cache-strategy#setcachekeyoptions'>SetCacheKeyOptions</a>) => `Promise<void>``}   />
 Sets a key-value pair in the cache. The value must be serializable, so cannot contain
 things like functions, circular data structures, class instances etc.
@@ -58,12 +58,12 @@ Optionally a "time to live" (ttl) can be specified, which means that the key wil
 be considered stale after that many milliseconds.
 ### delete
-<MemberInfo kind="method" type={`(key: string) => Promise<void>`}   />
+<MemberInfo kind="method" type={`(key: string) => `Promise<void>``}   />
 Deletes an item from the cache.
 ### invalidateTags
-<MemberInfo kind="method" type={`(tags: string[]) => Promise<void>`}   />
+<MemberInfo kind="method" type={`(tags: string[]) => `Promise<void>``}   />
 Deletes all items from the cache which contain at least one matching tag.

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

@@ -36,13 +36,13 @@ interface CacheStrategy extends InjectableStrategy {
 ### get
-<MemberInfo kind="method" type={`(key: string) => Promise<T | undefined>`}   />
+<MemberInfo kind="method" type={`(key: string) => `Promise<T | undefined>``}   />
 Gets an item from the cache, or returns undefined if the key is not found, or the
 item has expired.
 ### set
-<MemberInfo kind="method" type={`(key: string, value: T, options?: <a href='/reference/typescript-api/cache/cache-strategy#setcachekeyoptions'>SetCacheKeyOptions</a>) => Promise<void>`}   />
+<MemberInfo kind="method" type={`(key: string, value: T, options?: <a href='/reference/typescript-api/cache/cache-strategy#setcachekeyoptions'>SetCacheKeyOptions</a>) => `Promise<void>``}   />
 Sets a key-value pair in the cache. The value must be serializable, so cannot contain
 things like functions, circular data structures, class instances etc.
@@ -51,12 +51,12 @@ Optionally a "time to live" (ttl) can be specified, which means that the key wil
 be considered stale after that many milliseconds.
 ### delete
-<MemberInfo kind="method" type={`(key: string) => Promise<void>`}   />
+<MemberInfo kind="method" type={`(key: string) => `Promise<void>``}   />
 Deletes an item from the cache.
 ### invalidateTags
-<MemberInfo kind="method" type={`(tags: string[]) => Promise<void>`}   />
+<MemberInfo kind="method" type={`(tags: string[]) => `Promise<void>``}   />
 Deletes all items from the cache which contain at least one matching tag.

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

@@ -55,18 +55,18 @@ class Cache {
 ### get
-<MemberInfo kind="method" type={`(id: string | number, getValueFn: () => T | Promise<T>) => Promise<T>`}   />
+<MemberInfo kind="method" type={`(id: string | number, getValueFn: `() => T | Promise<T>`) => `Promise<T>``}   />
 Retrieves the value from the cache if it exists, otherwise calls the `getValueFn` function
 to get the value, sets it in the cache and returns it.
 ### delete
-<MemberInfo kind="method" type={`(id: string | number | Array<string | number>) => Promise<void>`}   />
+<MemberInfo kind="method" type={`(id: `string | number | Array<string | number>`) => `Promise<void>``}   />
 Deletes one or more items from the cache.
 ### invalidateTags
-<MemberInfo kind="method" type={`(tags: string[]) => Promise<void>`}   />
+<MemberInfo kind="method" type={`(tags: string[]) => `Promise<void>``}   />
 Invalidates one or more tags in the cache.

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

@@ -47,22 +47,22 @@ class RedisCacheStrategy implements CacheStrategy {
 ### get
-<MemberInfo kind="method" type={`(key: string) => Promise<T | undefined>`}   />
+<MemberInfo kind="method" type={`(key: string) => `Promise<T | undefined>``}   />
 ### set
-<MemberInfo kind="method" type={`(key: string, value: T, options?: <a href='/reference/typescript-api/cache/cache-strategy#setcachekeyoptions'>SetCacheKeyOptions</a>) => Promise<void>`}   />
+<MemberInfo kind="method" type={`(key: string, value: T, options?: <a href='/reference/typescript-api/cache/cache-strategy#setcachekeyoptions'>SetCacheKeyOptions</a>) => `Promise<void>``}   />
 ### delete
-<MemberInfo kind="method" type={`(key: string) => Promise<void>`}   />
+<MemberInfo kind="method" type={`(key: string) => `Promise<void>``}   />
 ### invalidateTags
-<MemberInfo kind="method" type={`(tags: string[]) => Promise<void>`}   />
+<MemberInfo kind="method" type={`(tags: string[]) => `Promise<void>``}   />

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

@@ -36,12 +36,12 @@ Get a value from the RequestContext cache. If the value is not found, the `getDe
 function will be called to get the value, which will then be cached and returned.
 ### get
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, key: any, getDefault?: () => T) => T`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, key: any, getDefault?: `() => T`) => T`}   />
 ### get
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, key: any, getDefault?: () => T) => T | Promise<T> | undefined`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, key: any, getDefault?: `() => T`) => `T | Promise<T> | undefined``}   />

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

@@ -22,13 +22,13 @@ interface SelfRefreshingCache<V, RefreshArgs extends any[] = []> {
 ### value
-<MemberInfo kind="method" type={`(refreshArgs: RefreshArgs | [undefined] | []) => Promise<V>`}   />
+<MemberInfo kind="method" type={`(refreshArgs: RefreshArgs | [undefined] | []) => `Promise<V>``}   />
 The current value of the cache. If the value is stale, the data will be refreshed and then
 the fresh value will be returned.
 ### memoize
-<MemberInfo kind="method" type={`(args: Args, refreshArgs: RefreshArgs, fn: (value: V, ...args: Args) => R) => Promise<R>`}   />
+<MemberInfo kind="method" type={`(args: Args, refreshArgs: RefreshArgs, fn: `(value: V, ...args: Args) => R`) => `Promise<R>``}   />
 Allows a memoized function to be defined. For the given arguments, the `fn` function will
 be invoked only once and its output cached and returned.
@@ -36,7 +36,7 @@ The results cache is cleared along with the rest of the cache according to the c
 `ttl` value.
 ### refresh
-<MemberInfo kind="method" type={`(args: RefreshArgs) => Promise<V>`}   />
+<MemberInfo kind="method" type={`(args: RefreshArgs) => `Promise<V>``}   />
 Force a refresh of the value, e.g. when it is known that the value has changed such as after
 an update operation to the source data in the database.
@@ -78,13 +78,13 @@ The time-to-live (ttl) in milliseconds for the cache. After this time, the value
 and will be refreshed the next time it is accessed.
 ### refresh
-<MemberInfo kind="property" type={`{         fn: (...args: RefreshArgs) => Promise<V>;         /**          * Default arguments, passed to refresh function          */         defaultArgs: RefreshArgs;     }`}   />
+<MemberInfo kind="property" type={``{         fn: (...args: RefreshArgs) => Promise<V>;         /**          * Default arguments, passed to refresh function          */         defaultArgs: RefreshArgs;     }``}   />
 The function which is used to refresh the value of the cache.
 This function should return a Promise which resolves to the new value.
 ### getTimeFn
-<MemberInfo kind="property" type={`() => number`}   />
+<MemberInfo kind="property" type={``() => number``}   />
 Intended for unit testing the SelfRefreshingCache only.
 By default uses `() => new Date().getTime()`

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

@@ -59,7 +59,7 @@ class SqlCacheStrategy implements CacheStrategy {
 ### get
-<MemberInfo kind="method" type={`(key: string) => Promise<T | undefined>`}   />
+<MemberInfo kind="method" type={`(key: string) => `Promise<T | undefined>``}   />
 ### set

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

@@ -30,7 +30,7 @@ index.html, the compiled js bundles etc.
 Specifies the url route to the Admin UI app.
 ### compile
-<MemberInfo kind="property" type={`() => Promise<void>`}   />
+<MemberInfo kind="property" type={``() => Promise<void>``}   />
 The function which will be invoked to start the app compilation process.

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

@@ -34,7 +34,7 @@ The port on which the dev server is listening. Overrides the value set by `Admin
 Specifies the url route to the Admin UI app.
 ### compile
-<MemberInfo kind="property" type={`() => Promise<void>`}   />
+<MemberInfo kind="property" type={``() => Promise<void>``}   />
 The function which will be invoked to start the app compilation process.

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

@@ -23,7 +23,7 @@ class AsyncQueue {
 ### push
-<MemberInfo kind="method" type={`(task: Task<T>) => Promise<T>`}   />
+<MemberInfo kind="method" type={`(task: `Task<T>`) => `Promise<T>``}   />
 Pushes a new task onto the queue, upon which the task will either execute immediately or
 (if the number of running tasks is equal to the concurrency limit) enqueue the task to

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

@@ -68,7 +68,7 @@ Parameters
 ### userConfig
-<MemberInfo kind="parameter" type={`Partial<<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>>`} />
+<MemberInfo kind="parameter" type={``Partial<`<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>`>``} />
 ### options
@@ -95,7 +95,7 @@ interface BootstrapOptions {
 These options get passed directly to the `NestFactory.create()` method.
 ### ignoreCompatibilityErrorsForPlugins
-<MemberInfo kind="property" type={`Array<DynamicModule | Type<any>>`} default={`[]`}  since="3.1.0"  />
+<MemberInfo kind="property" type={``Array<DynamicModule | Type<any>>``} default={`[]`}  since="3.1.0"  />
 By default, if a plugin specifies a compatibility range which does not include the current
 Vendure version, the bootstrap process will fail. This option allows you to ignore compatibility

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

@@ -18,7 +18,7 @@ interface InjectableStrategy {
 ### init
-<MemberInfo kind="property" type={`(injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>) => void | Promise<void>`}   />
+<MemberInfo kind="property" type={`(injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>`) => void | Promise<void>``}   />
 Defines setup logic to be run during application bootstrap. Receives
 the <DocsLink href="/reference/typescript-api/common/injector#injector">Injector</DocsLink> as an argument, which allows application providers
@@ -35,7 +35,7 @@ async init(injector: Injector) {
 ```
 ### destroy
-<MemberInfo kind="property" type={`() => void | Promise<void>`}   />
+<MemberInfo kind="property" type={``() => void | Promise<void>``}   />
 Defines teardown logic to be run before application shutdown.

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

@@ -26,13 +26,13 @@ class Injector {
 ### get
-<MemberInfo kind="method" type={`(typeOrToken: Type<T> | string | symbol) => R`}   />
+<MemberInfo kind="method" type={`(typeOrToken: `Type<T> | string | symbol`) => R`}   />
 Retrieve an instance of the given type from the app's dependency injection container.
 Wraps the Nestjs `ModuleRef.get()` method.
 ### resolve
-<MemberInfo kind="method" type={`(typeOrToken: Type<T> | string | symbol, contextId?: ContextId) => Promise<R>`}   />
+<MemberInfo kind="method" type={`(typeOrToken: `Type<T> | string | symbol`, contextId?: ContextId) => `Promise<R>``}   />
 Retrieve an instance of the given scoped provider (transient or request-scoped) from the
 app's dependency injection container.

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

@@ -76,7 +76,7 @@ type ConfigArgs = {
 ### [index]
-<MemberInfo kind="property" type={`ConfigArgDef<<a href='/reference/typescript-api/configurable-operation-def/config-arg-type#configargtype'>ConfigArgType</a>>`}   />
+<MemberInfo kind="property" type={``ConfigArgDef<`<a href='/reference/typescript-api/configurable-operation-def/config-arg-type#configargtype'>ConfigArgType</a>`>``}   />

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

@@ -39,17 +39,17 @@ type DefaultFormConfigHash = {
 ### 'boolean-form-input'
-<MemberInfo kind="property" type={`Record<string, never>`}   />
+<MemberInfo kind="property" type={``Record<string, never>``}   />
 ### 'currency-form-input'
-<MemberInfo kind="property" type={`Record<string, never>`}   />
+<MemberInfo kind="property" type={``Record<string, never>``}   />
 ### 'customer-group-form-input'
-<MemberInfo kind="property" type={`Record<string, never>`}   />
+<MemberInfo kind="property" type={``Record<string, never>``}   />
 ### 'date-form-input'
@@ -59,7 +59,7 @@ type DefaultFormConfigHash = {
 ### 'facet-value-form-input'
-<MemberInfo kind="property" type={`Record<string, never>`}   />
+<MemberInfo kind="property" type={``Record<string, never>``}   />
 ### 'json-editor-form-input'
@@ -79,27 +79,27 @@ type DefaultFormConfigHash = {
 ### 'password-form-input'
-<MemberInfo kind="property" type={`Record<string, never>`}   />
+<MemberInfo kind="property" type={``Record<string, never>``}   />
 ### 'product-selector-form-input'
-<MemberInfo kind="property" type={`Record<string, never>`}   />
+<MemberInfo kind="property" type={``Record<string, never>``}   />
 ### 'relation-form-input'
-<MemberInfo kind="property" type={`Record<string, never>`}   />
+<MemberInfo kind="property" type={``Record<string, never>``}   />
 ### 'rich-text-form-input'
-<MemberInfo kind="property" type={`Record<string, never>`}   />
+<MemberInfo kind="property" type={``Record<string, never>``}   />
 ### 'select-form-input'
-<MemberInfo kind="property" type={`{         options?: Array<{ value: string; label?: Array<Omit<LocalizedString, '__typename'>> }>;     }`}   />
+<MemberInfo kind="property" type={``{         options?: Array<{ value: string; label?: Array<Omit<LocalizedString, '__typename'>> }>;     }``}   />
 ### 'text-form-input'
@@ -119,12 +119,12 @@ type DefaultFormConfigHash = {
 ### 'combination-mode-form-input'
-<MemberInfo kind="property" type={`Record<string, never>`}   />
+<MemberInfo kind="property" type={``Record<string, never>``}   />
 ### 'struct-form-input'
-<MemberInfo kind="property" type={`Record<string, never>`}   />
+<MemberInfo kind="property" type={``Record<string, never>``}   />

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

@@ -130,7 +130,7 @@ Convert a ConfigurableOperationDef into a ConfigurableOperationDefinition object
 so that it can be sent via the API.
 ### argsArrayToHash
-<MemberInfo kind="method" type={`(args: ConfigArg[]) => ConfigArgValues<T>`}   />
+<MemberInfo kind="method" type={`(args: ConfigArg[]) => `ConfigArgValues<T>``}   />
 Coverts an array of ConfigArgs into a hash object:

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

@@ -90,13 +90,13 @@ The maximum number of items that may be returned by a query which returns a `Pag
 this is the upper limit of the `take` input option.
 ### adminApiValidationRules
-<MemberInfo kind="property" type={`Array<(context: ValidationContext) => any>`} default={`[]`}   />
+<MemberInfo kind="property" type={``Array<(context: ValidationContext) => any>``} default={`[]`}   />
 Custom functions to use as additional validation rules when validating the schema for the admin GraphQL API
 [ApolloServer validation rules](https://www.apollographql.com/docs/apollo-server/api/apollo-server/#validationrules).
 ### shopApiValidationRules
-<MemberInfo kind="property" type={`Array<(context: ValidationContext) => any>`} default={`[]`}   />
+<MemberInfo kind="property" type={``Array<(context: ValidationContext) => any>``} default={`[]`}   />
 Custom functions to use as additional validation rules when validating the schema for the shop GraphQL API
 [ApolloServer validation rules](https://www.apollographql.com/docs/apollo-server/api/apollo-server/#validationrules).

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

@@ -58,12 +58,12 @@ class CollectionFilter<T extends ConfigArgs = ConfigArgs> extends ConfigurableOp
 ### constructor
-<MemberInfo kind="method" type={`(config: CollectionFilterConfig<T>) => CollectionFilter`}   />
+<MemberInfo kind="method" type={`(config: `CollectionFilterConfig<T>`) => CollectionFilter`}   />
 ### apply
-<MemberInfo kind="method" type={`(qb: SelectQueryBuilder<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>, args: ConfigArg[]) => SelectQueryBuilder<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>`}   />
+<MemberInfo kind="method" type={`(qb: `SelectQueryBuilder<`<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>`>`, args: ConfigArg[]) => `SelectQueryBuilder<`<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>`>``}   />

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

@@ -114,7 +114,7 @@ class EntityDuplicator<T extends ConfigArgs = ConfigArgs> extends ConfigurableOp
 ### duplicate
-<MemberInfo kind="method" type={`(input: {         ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>;         entityName: string;         id: <a href='/reference/typescript-api/common/id#id'>ID</a>;         args: ConfigArg[];     }) => Promise<<a href='/reference/typescript-api/entities/vendure-entity#vendureentity'>VendureEntity</a>>`}   />
+<MemberInfo kind="method" type={`(input: {         ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>;         entityName: string;         id: <a href='/reference/typescript-api/common/id#id'>ID</a>;         args: ConfigArg[];     }) => `Promise<`<a href='/reference/typescript-api/entities/vendure-entity#vendureentity'>VendureEntity</a>`>``}   />
@@ -151,7 +151,7 @@ interface EntityDuplicatorConfig<T extends ConfigArgs> extends ConfigurableOpera
 ### requiresPermission
-<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/common/permission#permission'>Permission</a> | string> | <a href='/reference/typescript-api/common/permission#permission'>Permission</a> | string`}   />
+<MemberInfo kind="property" type={``Array<`<a href='/reference/typescript-api/common/permission#permission'>Permission</a>` | string> | `<a href='/reference/typescript-api/common/permission#permission'>Permission</a> | string`}   />
 The permissions required in order to execute this duplicator. If an array is passed,
 then the administrator must have at least one of the permissions in the array.