npm - @vendure/docs - Versions diffs - 0.0.0-202601201656 → 0.0.0-202601210957 - Mend

@vendure/docs 0.0.0-202601201656 → 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.

Files changed (378) hide show

package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx CHANGED Viewed

@@ -42,7 +42,7 @@ interface NavMenuItem {
 ### onClick
-<MemberInfo kind="property" type={`(event: MouseEvent) =&#62; void`}   />
+<MemberInfo kind="property" type={`(event: MouseEvent) => void`}   />
 ### icon
@@ -52,12 +52,12 @@ interface NavMenuItem {
 ### requiresPermission
-<MemberInfo kind="property" type={`string | ((userPermissions: string[]) =&#62; boolean)`}   />
+<MemberInfo kind="property" type={`string | ((userPermissions: string[]) => boolean)`}   />
 ### statusBadge
-<MemberInfo kind="property" type={`Observable&#60;<a href='/reference/admin-ui-api/nav-menu/navigation-types#navmenubadge'>NavMenuBadge</a>&#62;`}   />
+<MemberInfo kind="property" type={`Observable<<a href='/reference/admin-ui-api/nav-menu/navigation-types#navmenubadge'>NavMenuBadge</a>>`}   />

package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx CHANGED Viewed

@@ -53,7 +53,7 @@ interface NavMenuSection {
 ### requiresPermission
-<MemberInfo kind="property" type={`string | ((userPermissions: string[]) =&#62; boolean)`}   />
+<MemberInfo kind="property" type={`string | ((userPermissions: string[]) => boolean)`}   />
 Control the display of this item based on the user permissions. Note: if you attempt to pass a
 <a href='/reference/typescript-api/auth/permission-definition#permissiondefinition'>PermissionDefinition</a> object, you will get a compilation error. Instead, pass the plain

package/docs/reference/admin-ui-api/react-components/action-bar.mdx CHANGED Viewed

@@ -31,5 +31,5 @@ Parameters
 ### props
-<MemberInfo kind="parameter" type={`PropsWithChildren&#60;{ leftContent?: ReactNode }&#62;`} />
+<MemberInfo kind="parameter" type={`PropsWithChildren<{ leftContent?: ReactNode }>`} />

package/docs/reference/admin-ui-api/react-components/card.mdx CHANGED Viewed

@@ -31,5 +31,5 @@ Parameters
 ### props
-<MemberInfo kind="parameter" type={`PropsWithChildren&#60;{ title?: string; paddingX?: boolean }&#62;`} />
+<MemberInfo kind="parameter" type={`PropsWithChildren<{ title?: string; paddingX?: boolean }>`} />

package/docs/reference/admin-ui-api/react-components/cds-icon.mdx CHANGED Viewed

@@ -29,5 +29,5 @@ Parameters
 ### props
-<MemberInfo kind="parameter" type={`{ icon: IconShapeTuple; className?: string } &#38; Partial&#60;CdsIconProps&#62;`} />
+<MemberInfo kind="parameter" type={`{ icon: IconShapeTuple; className?: string } &#38; Partial<CdsIconProps>`} />

package/docs/reference/admin-ui-api/react-components/form-field.mdx CHANGED Viewed

@@ -37,5 +37,5 @@ Parameters
 ### props
-<MemberInfo kind="parameter" type={`PropsWithChildren&#60;{         for?: string;         label?: string;         tooltip?: string;         invalid?: boolean;         errorMessage?: string;     }&#62;`} />
+<MemberInfo kind="parameter" type={`PropsWithChildren<{         for?: string;         label?: string;         tooltip?: string;         invalid?: boolean;         errorMessage?: string;     }>`} />

package/docs/reference/admin-ui-api/react-components/link.mdx CHANGED Viewed

@@ -29,5 +29,5 @@ Parameters
 ### props
-<MemberInfo kind="parameter" type={`PropsWithChildren&#60;{ href: string; [props: string]: any }&#62;`} />
+<MemberInfo kind="parameter" type={`PropsWithChildren<{ href: string; [props: string]: any }>`} />

package/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx CHANGED Viewed

@@ -31,5 +31,5 @@ Parameters
 ### props
-<MemberInfo kind="parameter" type={`PropsWithChildren&#60;{ sidebar?: ReactNode }&#62;`} />
+<MemberInfo kind="parameter" type={`PropsWithChildren<{ sidebar?: ReactNode }>`} />

package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.mdx CHANGED Viewed

@@ -32,7 +32,7 @@ The id of the detail page location in which to place the component.
 The React component to render.
 ### props
-<MemberInfo kind="property" type={`Record&#60;string, any&#62;`}   />
+<MemberInfo kind="property" type={`Record<string, any>`}   />
 Optional props to pass to the React component.

package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx CHANGED Viewed

@@ -39,7 +39,7 @@ The component to render in the table cell. This component will receive the `rowI
 which is the data object for the row, e.g. the `Product` object if used in the `product-list` table.
 ### props
-<MemberInfo kind="property" type={`Record&#60;string, any&#62;`}   />
+<MemberInfo kind="property" type={`Record<string, any>`}   />
 Optional props to pass to the React component.

package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx CHANGED Viewed

@@ -17,5 +17,5 @@ Parameters
 ### options
-<MemberInfo kind="parameter" type={`<a href='/reference/admin-ui-api/react-extensions/register-react-route-component-options#registerreactroutecomponentoptions'>RegisterReactRouteComponentOptions</a>&#60;Entity, T, Field, R&#62;`} />
+<MemberInfo kind="parameter" type={`<a href='/reference/admin-ui-api/react-extensions/register-react-route-component-options#registerreactroutecomponentoptions'>RegisterReactRouteComponentOptions</a><Entity, T, Field, R>`} />

package/docs/reference/admin-ui-api/react-hooks/use-injector.mdx CHANGED Viewed

@@ -34,5 +34,5 @@ Parameters
 ### token
-<MemberInfo kind="parameter" type={`ProviderToken&#60;T&#62;`} />
+<MemberInfo kind="parameter" type={`ProviderToken<T>`} />

package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx CHANGED Viewed

@@ -65,7 +65,7 @@ Parameters
 ### query
-<MemberInfo kind="parameter" type={`DocumentNode | TypedDocumentNode&#60;T, V&#62;`} />
+<MemberInfo kind="parameter" type={`DocumentNode | TypedDocumentNode<T, V>`} />
 ### options

package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx CHANGED Viewed

@@ -57,5 +57,5 @@ Parameters
 ### mutation
-<MemberInfo kind="parameter" type={`DocumentNode | TypedDocumentNode&#60;T, V&#62;`} />
+<MemberInfo kind="parameter" type={`DocumentNode | TypedDocumentNode<T, V>`} />

package/docs/reference/admin-ui-api/react-hooks/use-query.mdx CHANGED Viewed

@@ -46,7 +46,7 @@ Parameters
 ### query
-<MemberInfo kind="parameter" type={`DocumentNode | TypedDocumentNode&#60;T, V&#62;`} />
+<MemberInfo kind="parameter" type={`DocumentNode | TypedDocumentNode<T, V>`} />
 ### variables

package/docs/reference/admin-ui-api/routes/register-route-component.mdx CHANGED Viewed

@@ -52,5 +52,5 @@ Parameters
 ### options
-<MemberInfo kind="parameter" type={`<a href='/reference/admin-ui-api/routes/register-route-component-options#registerroutecomponentoptions'>RegisterRouteComponentOptions</a>&#60;Component, Entity, T, Field, R&#62;`} />
+<MemberInfo kind="parameter" type={`<a href='/reference/admin-ui-api/routes/register-route-component-options#registerroutecomponentoptions'>RegisterRouteComponentOptions</a><Component, Entity, T, Field, R>`} />

package/docs/reference/admin-ui-api/services/data-service.mdx CHANGED Viewed

@@ -24,7 +24,7 @@ class DataService {
 ### query
-<MemberInfo kind="method" type={`(query: DocumentNode | TypedDocumentNode&#60;T, V&#62;, variables?: V, fetchPolicy: WatchQueryFetchPolicy = 'cache-and-network', options: ExtendedQueryOptions = {}) => <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a>&#60;T, V&#62;`}   />
+<MemberInfo kind="method" type={`(query: DocumentNode | TypedDocumentNode<T, V>, variables?: V, fetchPolicy: WatchQueryFetchPolicy = 'cache-and-network', options: ExtendedQueryOptions = {}) => <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a><T, V>`}   />
 Perform a GraphQL query. Returns a <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a> which allows further control over
 they type of result returned, e.g. stream of values, single value etc.
@@ -45,7 +45,7 @@ const result$ = this.dataService.query(gql`
 ```
 ### mutate
-<MemberInfo kind="method" type={`(mutation: DocumentNode | TypedDocumentNode&#60;T, V&#62;, variables?: V, update?: MutationUpdaterFunction&#60;T, V, any, any&#62;, options: ExtendedQueryOptions = {}) => Observable&#60;T&#62;`}   />
+<MemberInfo kind="method" type={`(mutation: DocumentNode | TypedDocumentNode<T, V>, variables?: V, update?: MutationUpdaterFunction<T, V, any, any>, options: ExtendedQueryOptions = {}) => Observable<T>`}   />
 Perform a GraphQL mutation.
@@ -92,43 +92,43 @@ class QueryResult<T, V extends Record<string, any> = Record<string, any>> {
 ### constructor
-<MemberInfo kind="method" type={`(queryRef: QueryRef&#60;T, V&#62;, apollo: Apollo, customFieldMap: Map&#60;string, <a href='/reference/typescript-api/custom-fields/custom-field-config#customfieldconfig'>CustomFieldConfig</a>[]&#62;) => QueryResult`}   />
+<MemberInfo kind="method" type={`(queryRef: QueryRef<T, V>, apollo: Apollo, customFieldMap: Map<string, <a href='/reference/typescript-api/custom-fields/custom-field-config#customfieldconfig'>CustomFieldConfig</a>[]>) => QueryResult`}   />
 ### refetchOnChannelChange
-<MemberInfo kind="method" type={`() => <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a>&#60;T, V&#62;`}   />
+<MemberInfo kind="method" type={`() => <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a><T, V>`}   />
 Re-fetch this query whenever the active Channel changes.
 ### refetchOnCustomFieldsChange
-<MemberInfo kind="method" type={`(customFieldsToInclude$: Observable&#60;string[]&#62;) => <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a>&#60;T, V&#62;`}  since="3.0.4"  />
+<MemberInfo kind="method" type={`(customFieldsToInclude$: Observable<string[]>) => <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a><T, V>`}  since="3.0.4"  />
 Re-fetch this query whenever the custom fields change, updating the query to include the
 specified custom fields.
 ### single$
-<MemberInfo kind="property" type={`Observable&#60;T&#62;`}   />
+<MemberInfo kind="property" type={`Observable<T>`}   />
 Returns an Observable which emits a single result and then completes.
 ### stream$
-<MemberInfo kind="property" type={`Observable&#60;T&#62;`}   />
+<MemberInfo kind="property" type={`Observable<T>`}   />
 Returns an Observable which emits until unsubscribed.
 ### ref
-<MemberInfo kind="property" type={`QueryRef&#60;T, V&#62;`}   />
+<MemberInfo kind="property" type={`QueryRef<T, V>`}   />
 ### mapSingle
-<MemberInfo kind="method" type={`(mapFn: (item: T) =&#62; R) => Observable&#60;R&#62;`}   />
+<MemberInfo kind="method" type={`(mapFn: (item: T) => R) => Observable<R>`}   />
 Returns a single-result Observable after applying the map function.
 ### mapStream
-<MemberInfo kind="method" type={`(mapFn: (item: T) =&#62; R) => Observable&#60;R&#62;`}   />
+<MemberInfo kind="method" type={`(mapFn: (item: T) => R) => Observable<R>`}   />
 Returns a multiple-result Observable after applying the map function.
 ### destroy

package/docs/reference/admin-ui-api/services/modal-service.mdx CHANGED Viewed

@@ -28,7 +28,7 @@ class ModalService {
 ### fromComponent
-<MemberInfo kind="method" type={`(component: Type&#60;T&#62; &#38; Type&#60;<a href='/reference/admin-ui-api/services/modal-service#dialog'>Dialog</a>&#60;R&#62;&#62;, options?: <a href='/reference/admin-ui-api/services/modal-service#modaloptions'>ModalOptions</a>&#60;T&#62;) => Observable&#60;R | undefined&#62;`}   />
+<MemberInfo kind="method" type={`(component: Type<T> &#38; Type<<a href='/reference/admin-ui-api/services/modal-service#dialog'>Dialog</a><R>>, options?: <a href='/reference/admin-ui-api/services/modal-service#modaloptions'>ModalOptions</a><T>) => Observable<R | undefined>`}   />
 Create a modal from a component. The component must implement the <a href='/reference/admin-ui-api/services/modal-service#dialog'>Dialog</a> interface.
 Additionally, the component should include templates for the title and the buttons to be
@@ -72,7 +72,7 @@ class MyDialog implements Dialog {
 ```
 ### dialog
-<MemberInfo kind="method" type={`(config: <a href='/reference/admin-ui-api/services/modal-service#dialogconfig'>DialogConfig</a>&#60;T&#62;) => Observable&#60;T | undefined&#62;`}   />
+<MemberInfo kind="method" type={`(config: <a href='/reference/admin-ui-api/services/modal-service#dialogconfig'>DialogConfig</a><T>) => Observable<T | undefined>`}   />
 Displays a modal dialog with the provided title, body and buttons.
@@ -97,7 +97,7 @@ interface Dialog<R = any> {
 ### resolveWith
-<MemberInfo kind="property" type={`(result?: R) =&#62; void`}   />
+<MemberInfo kind="property" type={`(result?: R) => void`}   />
 Function to be invoked in order to close the dialog when the action is complete.
 The Observable returned from the .fromComponent() method will emit the value passed
@@ -142,7 +142,7 @@ interface DialogConfig<T> {
 ### buttons
-<MemberInfo kind="property" type={`Array&#60;DialogButtonConfig&#60;T&#62;&#62;`}   />
+<MemberInfo kind="property" type={`Array<DialogButtonConfig<T>>`}   />
 ### size
@@ -190,7 +190,7 @@ When true, the "x" icon is shown
 and clicking it or the mask will close the dialog
 ### locals
-<MemberInfo kind="property" type={`Partial&#60;T&#62;`}   />
+<MemberInfo kind="property" type={`Partial<T>`}   />
 Values to be passed directly to the component being instantiated inside the dialog.

package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx CHANGED Viewed

@@ -54,7 +54,7 @@ The name of the tab to display in the UI.
 The priority of the tab. Tabs with a lower priority will be displayed first.
 ### component
-<MemberInfo kind="property" type={`Type&#60;any&#62; | ReturnType&#60;typeof <a href='/reference/admin-ui-api/list-detail-views/detail-component-with-resolver#detailcomponentwithresolver'>detailComponentWithResolver</a>&#62;`}   />
+<MemberInfo kind="property" type={`Type<any> | ReturnType<typeof <a href='/reference/admin-ui-api/list-detail-views/detail-component-with-resolver#detailcomponentwithresolver'>detailComponentWithResolver</a>>`}   />
 The component to render at the route of the tab.
 ### routeConfig

package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx CHANGED Viewed

@@ -28,7 +28,7 @@ interface AdminUiExtension extends Partial<TranslationExtension>,
     exclude?: string[];
 }
 ```
-* Extends: <code>Partial&#60;<a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#translationextension'>TranslationExtension</a>&#62;</code>, <code>Partial&#60;<a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#staticassetextension'>StaticAssetExtension</a>&#62;</code>, <code>Partial&#60;<a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#globalstylesextension'>GlobalStylesExtension</a>&#62;</code>
+* Extends: <code>Partial<<a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#translationextension'>TranslationExtension</a>></code>, <code>Partial<<a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#staticassetextension'>StaticAssetExtension</a>></code>, <code>Partial<<a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#globalstylesextension'>GlobalStylesExtension</a>></code>
@@ -49,7 +49,7 @@ will be copied into the Admin UI app, including all TypeScript source files, htm
 scss style sheets etc.
 ### ngModules
-<MemberInfo kind="property" type={`Array&#60;<a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#adminuiextensionsharedmodule'>AdminUiExtensionSharedModule</a> | <a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#adminuiextensionlazymodule'>AdminUiExtensionLazyModule</a>&#62;`}   />
+<MemberInfo kind="property" type={`Array<<a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#adminuiextensionsharedmodule'>AdminUiExtensionSharedModule</a> | <a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#adminuiextensionlazymodule'>AdminUiExtensionLazyModule</a>>`}   />
 One or more Angular modules which extend the default Admin UI.
 ### providers

package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx CHANGED Viewed

@@ -52,7 +52,7 @@ Admin UI. This option can be used to override this default build with a differen
 version, e.g. one pre-compiled with one or more ui extensions.
 ### adminUiConfig
-<MemberInfo kind="property" type={`Partial&#60;<a href='/reference/typescript-api/common/admin-ui/admin-ui-config#adminuiconfig'>AdminUiConfig</a>&#62;`}   />
+<MemberInfo kind="property" type={`Partial<<a href='/reference/typescript-api/common/admin-ui/admin-ui-config#adminuiconfig'>AdminUiConfig</a>>`}   />
 Allows the contents of the `vendure-ui-config.json` file to be set, e.g.
 for specifying the Vendure GraphQL API host, available UI languages, etc.

package/docs/reference/core-plugins/admin-ui-plugin/index.mdx CHANGED Viewed

@@ -80,7 +80,7 @@ class AdminUiPlugin implements NestModule {
 ### init
-<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options#adminuipluginoptions'>AdminUiPluginOptions</a>) => Type&#60;<a href='/reference/core-plugins/admin-ui-plugin/#adminuiplugin'>AdminUiPlugin</a>&#62;`}   />
+<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options#adminuipluginoptions'>AdminUiPluginOptions</a>) => Type<<a href='/reference/core-plugins/admin-ui-plugin/#adminuiplugin'>AdminUiPlugin</a>>`}   />
 Set the plugin options
 ### configure

package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx CHANGED Viewed

@@ -42,7 +42,7 @@ The route to the asset server.
 The local directory to which assets will be uploaded when using the <a href='/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy'>LocalAssetStorageStrategy</a>.
 ### assetUrlPrefix
-<MemberInfo kind="property" type={`string | ((ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, identifier: string) =&#62; string)`}   />
+<MemberInfo kind="property" type={`string | ((ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, identifier: string) => string)`}   />
 The complete URL prefix of the asset files. For example, "https://demo.vendure.io/assets/". A
 function can also be provided to handle more complex cases, such as serving multiple domains
@@ -90,7 +90,7 @@ Defines how previews are generated for a given Asset binary. By default, this us
 the <a href='/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy#sharpassetpreviewstrategy'>SharpAssetPreviewStrategy</a>
 ### storageStrategyFactory
-<MemberInfo kind="property" type={`(         options: <a href='/reference/core-plugins/asset-server-plugin/asset-server-options#assetserveroptions'>AssetServerOptions</a>,     ) =&#62; <a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a> | Promise&#60;<a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a>&#62;`} default={`() =&#62; <a href='/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy'>LocalAssetStorageStrategy</a>`}   />
+<MemberInfo kind="property" type={`(         options: <a href='/reference/core-plugins/asset-server-plugin/asset-server-options#assetserveroptions'>AssetServerOptions</a>,     ) => <a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a> | Promise<<a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a>>`} default={`() => <a href='/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy'>LocalAssetStorageStrategy</a>`}   />
 A function which can be used to configure an <a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a>. This is useful e.g. if you wish to store your assets
 using a cloud storage provider. By default, the <a href='/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy'>LocalAssetStorageStrategy</a> is used.

package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx CHANGED Viewed

@@ -33,7 +33,7 @@ interface ImageTransformStrategy extends InjectableStrategy {
 ### getImageTransformParameters
-<MemberInfo kind="method" type={`(args: <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#getimagetransformparametersargs'>GetImageTransformParametersArgs</a>) => Promise&#60;<a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>&#62; | <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>`}   />
+<MemberInfo kind="method" type={`(args: <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#getimagetransformparametersargs'>GetImageTransformParametersArgs</a>) => Promise<<a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>> | <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>`}   />
 Given the input parameters, return the parameters which should be used to transform the image.

package/docs/reference/core-plugins/asset-server-plugin/index.mdx CHANGED Viewed

@@ -170,7 +170,7 @@ class AssetServerPlugin implements NestModule, OnApplicationBootstrap, OnApplica
 ### init
-<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/asset-server-plugin/asset-server-options#assetserveroptions'>AssetServerOptions</a>) => Type&#60;<a href='/reference/core-plugins/asset-server-plugin/#assetserverplugin'>AssetServerPlugin</a>&#62;`}   />
+<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/asset-server-plugin/asset-server-options#assetserveroptions'>AssetServerOptions</a>) => Type<<a href='/reference/core-plugins/asset-server-plugin/#assetserverplugin'>AssetServerPlugin</a>>`}   />
 Set the plugin options.
 ### constructor

package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx CHANGED Viewed

@@ -30,42 +30,42 @@ class LocalAssetStorageStrategy implements AssetStorageStrategy {
 ### toAbsoluteUrl
-<MemberInfo kind="property" type={`((reqest: Request, identifier: string) =&#62; string) | undefined`}   />
+<MemberInfo kind="property" type={`((reqest: Request, identifier: string) => string) | undefined`}   />
 ### constructor
-<MemberInfo kind="method" type={`(uploadPath: string, toAbsoluteUrlFn?: (reqest: Request, identifier: string) =&#62; string) => LocalAssetStorageStrategy`}   />
+<MemberInfo kind="method" type={`(uploadPath: string, toAbsoluteUrlFn?: (reqest: Request, identifier: string) => string) => LocalAssetStorageStrategy`}   />
 ### writeFileFromStream
-<MemberInfo kind="method" type={`(fileName: string, data: ReadStream) => Promise&#60;string&#62;`}   />
+<MemberInfo kind="method" type={`(fileName: string, data: ReadStream) => Promise<string>`}   />
 ### writeFileFromBuffer
-<MemberInfo kind="method" type={`(fileName: string, data: Buffer) => Promise&#60;string&#62;`}   />
+<MemberInfo kind="method" type={`(fileName: string, data: Buffer) => Promise<string>`}   />
 ### fileExists
-<MemberInfo kind="method" type={`(fileName: string) => Promise&#60;boolean&#62;`}   />
+<MemberInfo kind="method" type={`(fileName: string) => Promise<boolean>`}   />
 ### readFileToBuffer
-<MemberInfo kind="method" type={`(identifier: string) => Promise&#60;Buffer&#62;`}   />
+<MemberInfo kind="method" type={`(identifier: string) => Promise<Buffer>`}   />
 ### readFileToStream
-<MemberInfo kind="method" type={`(identifier: string) => Promise&#60;Stream&#62;`}   />
+<MemberInfo kind="method" type={`(identifier: string) => Promise<Stream>`}   />
 ### deleteFile
-<MemberInfo kind="method" type={`(identifier: string) => Promise&#60;void&#62;`}   />
+<MemberInfo kind="method" type={`(identifier: string) => Promise<void>`}   />

package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx CHANGED Viewed

@@ -65,7 +65,7 @@ class PresetOnlyStrategy implements ImageTransformStrategy {
 <MemberInfo kind="method" type={`({
         input,
         availablePresets,
-    }: <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#getimagetransformparametersargs'>GetImageTransformParametersArgs</a>) => Promise&#60;<a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>&#62; | <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>`}   />
+    }: <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#getimagetransformparametersargs'>GetImageTransformParametersArgs</a>) => Promise<<a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>> | <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>`}   />

package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx CHANGED Viewed

@@ -45,7 +45,7 @@ class S3AssetStorageStrategy implements AssetStorageStrategy {
 ### constructor
-<MemberInfo kind="method" type={`(s3Config: <a href='/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy#s3config'>S3Config</a>, toAbsoluteUrl: (request: Request, identifier: string) =&#62; string) => S3AssetStorageStrategy`}   />
+<MemberInfo kind="method" type={`(s3Config: <a href='/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy#s3config'>S3Config</a>, toAbsoluteUrl: (request: Request, identifier: string) => string) => S3AssetStorageStrategy`}   />
 ### init
@@ -55,7 +55,7 @@ class S3AssetStorageStrategy implements AssetStorageStrategy {
 ### destroy
-<MemberInfo kind="property" type={`(() =&#62; void | Promise&#60;void&#62;) | undefined`}   />
+<MemberInfo kind="property" type={`(() => void | Promise<void>) | undefined`}   />
 ### writeFileFromBuffer

package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx CHANGED Viewed

@@ -47,7 +47,7 @@ class SharpAssetPreviewStrategy implements AssetPreviewStrategy {
 ### generatePreviewImage
-<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, mimeType: string, data: Buffer) => Promise&#60;Buffer&#62;`}   />
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, mimeType: string, data: Buffer) => Promise<Buffer>`}   />

package/docs/reference/core-plugins/dashboard-plugin/index.mdx CHANGED Viewed

@@ -92,7 +92,7 @@ class DashboardPlugin implements NestModule {
 ### init
-<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/dashboard-plugin/dashboard-plugin-options#dashboardpluginoptions'>DashboardPluginOptions</a>) => Type&#60;<a href='/reference/core-plugins/dashboard-plugin/#dashboardplugin'>DashboardPlugin</a>&#62;`}   />
+<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/dashboard-plugin/dashboard-plugin-options#dashboardpluginoptions'>DashboardPluginOptions</a>) => Type<<a href='/reference/core-plugins/dashboard-plugin/#dashboardplugin'>DashboardPlugin</a>>`}   />
 Set the plugin options
 ### configure

package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx CHANGED Viewed

@@ -174,7 +174,7 @@ bulk operation is executed.
 Configuration of the internal Elasticsearch query.
 ### customProductMappings
-<MemberInfo kind="property" type={`{         [fieldName: string]: CustomMapping&#60;             [<a href='/reference/typescript-api/entities/product#product'>Product</a>, <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>[], <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>, <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>]         &#62;;     }`}   />
+<MemberInfo kind="property" type={`{         [fieldName: string]: CustomMapping<             [<a href='/reference/typescript-api/entities/product#product'>Product</a>, <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>[], <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>, <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>]         >;     }`}   />
 Custom mappings may be defined which will add the defined data to the
 Elasticsearch index and expose that data via the SearchResult GraphQL type,
@@ -237,7 +237,7 @@ query SearchProducts($input: SearchInput!) {
 ```
 ### customProductVariantMappings
-<MemberInfo kind="property" type={`{         [fieldName: string]: CustomMapping&#60;[<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>, <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>, <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>]&#62;;     }`}   />
+<MemberInfo kind="property" type={`{         [fieldName: string]: CustomMapping<[<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>, <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>, <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>]>;     }`}   />
 This config option defines custom mappings which are accessible when the "groupByProduct" and "groupBySKU"
 input options are both set to `false`. In addition, custom product mappings can be accessed by using
@@ -278,7 +278,7 @@ and also performs optimizations to minimize the amount of work that needs to be
 the worker.
 ### hydrateProductRelations
-<MemberInfo kind="property" type={`Array&#60;<a href='/reference/typescript-api/common/entity-relation-paths#entityrelationpaths'>EntityRelationPaths</a>&#60;<a href='/reference/typescript-api/entities/product#product'>Product</a>&#62;&#62;`} default={`[]`}  since="1.3.0"  />
+<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/common/entity-relation-paths#entityrelationpaths'>EntityRelationPaths</a><<a href='/reference/typescript-api/entities/product#product'>Product</a>>>`} default={`[]`}  since="1.3.0"  />
 Additional product relations that will be fetched from DB while reindexing. This can be used
 in combination with `customProductMappings` to ensure that the required relations are joined
@@ -301,13 +301,13 @@ before the `product` object is passed to the `valueFn`.
 ```
 ### hydrateProductVariantRelations
-<MemberInfo kind="property" type={`Array&#60;<a href='/reference/typescript-api/common/entity-relation-paths#entityrelationpaths'>EntityRelationPaths</a>&#60;<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>&#62;&#62;`} default={`[]`}  since="1.3.0"  />
+<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/common/entity-relation-paths#entityrelationpaths'>EntityRelationPaths</a><<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>>`} default={`[]`}  since="1.3.0"  />
 Additional variant relations that will be fetched from DB while reindexing. See
 `hydrateProductRelations` for more explanation and a usage example.
 ### extendSearchInputType
-<MemberInfo kind="property" type={`{         [name: string]: PrimitiveTypeVariations&#60;GraphQlPrimitive&#62;;     }`} default={`{}`}  since="1.3.0"  />
+<MemberInfo kind="property" type={`{         [name: string]: PrimitiveTypeVariations<GraphQlPrimitive>;     }`} default={`{}`}  since="1.3.0"  />
 Allows the `SearchInput` type to be extended with new input fields. This allows arbitrary
 data to be passed in, which can then be used e.g. in the `mapQuery()` function or
@@ -467,7 +467,7 @@ The interval used to group search results into buckets according to price range.
 ```
 ### mapQuery
-<MemberInfo kind="property" type={`(         query: any,         input: ElasticSearchInput,         searchConfig: DeepRequired&#60;<a href='/reference/core-plugins/elasticsearch-plugin/elasticsearch-options#searchconfig'>SearchConfig</a>&#62;,         channelId: <a href='/reference/typescript-api/common/id#id'>ID</a>,         enabledOnly: boolean,         ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,     ) =&#62; any`}   />
+<MemberInfo kind="property" type={`(         query: any,         input: ElasticSearchInput,         searchConfig: DeepRequired<<a href='/reference/core-plugins/elasticsearch-plugin/elasticsearch-options#searchconfig'>SearchConfig</a>>,         channelId: <a href='/reference/typescript-api/common/id#id'>ID</a>,         enabledOnly: boolean,         ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,     ) => any`}   />
 This config option allows the the modification of the whole (already built) search query. This allows
 for e.g. wildcard / fuzzy searches on the index.
@@ -506,7 +506,7 @@ mapQuery: (query, input, searchConfig, channelId, enabledOnly, ctx) => {
 ```
 ### scriptFields
-<MemberInfo kind="property" type={`{ [fieldName: string]: CustomScriptMapping&#60;[ElasticSearchInput]&#62; }`}  since="1.3.0"  />
+<MemberInfo kind="property" type={`{ [fieldName: string]: CustomScriptMapping<[ElasticSearchInput]> }`}  since="1.3.0"  />
 Sets `script_fields` inside the elasticsearch body which allows returning a script evaluation for each hit.
@@ -567,7 +567,7 @@ searchConfig: {
 ```
 ### mapSort
-<MemberInfo kind="property" type={`(sort: ElasticSearchSortInput, input: ElasticSearchInput) =&#62; ElasticSearchSortInput`} default={`{}`}  since="1.4.0"  />
+<MemberInfo kind="property" type={`(sort: ElasticSearchSortInput, input: ElasticSearchInput) => ElasticSearchSortInput`} default={`{}`}  since="1.4.0"  />
 Allows extending the `sort` input of the elasticsearch body as covered in
 [Elasticsearch sort docs](https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html)

package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx CHANGED Viewed

@@ -184,7 +184,7 @@ class ElasticsearchPlugin implements OnApplicationBootstrap {
 ### init
-<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/elasticsearch-plugin/elasticsearch-options#elasticsearchoptions'>ElasticsearchOptions</a>) => Type&#60;<a href='/reference/core-plugins/elasticsearch-plugin/#elasticsearchplugin'>ElasticsearchPlugin</a>&#62;`}   />
+<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/elasticsearch-plugin/elasticsearch-options#elasticsearchoptions'>ElasticsearchOptions</a>) => Type<<a href='/reference/core-plugins/elasticsearch-plugin/#elasticsearchplugin'>ElasticsearchPlugin</a>>`}   />

package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx CHANGED Viewed

@@ -16,7 +16,7 @@ class EmailEventHandlerWithAsyncData<Data, T extends string = string, InputEvent
     constructor(_loadDataFn: LoadDataFn<InputEvent, Data>, listener: EmailEventListener<T>, event: Type<InputEvent>)
 }
 ```
-* Extends: <code><a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>&#60;T, Event&#62;</code>
+* Extends: <code><a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event></code>
@@ -24,7 +24,7 @@ class EmailEventHandlerWithAsyncData<Data, T extends string = string, InputEvent
 ### constructor
-<MemberInfo kind="method" type={`(_loadDataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loaddatafn'>LoadDataFn</a>&#60;InputEvent, Data&#62;, listener: <a href='/reference/core-plugins/email-plugin/email-event-listener#emaileventlistener'>EmailEventListener</a>&#60;T&#62;, event: Type&#60;InputEvent&#62;) => EmailEventHandlerWithAsyncData`}   />
+<MemberInfo kind="method" type={`(_loadDataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loaddatafn'>LoadDataFn</a><InputEvent, Data>, listener: <a href='/reference/core-plugins/email-plugin/email-event-listener#emaileventlistener'>EmailEventListener</a><T>, event: Type<InputEvent>) => EmailEventHandlerWithAsyncData`}   />