• Preparing search index...
  • The search index is not available
@umbraco-cms/backoffice
  • @umbraco-cms/backoffice
  • packages/core/extension-registry
  • createExtensionApiByAlias

Function createExtensionApiByAlias

  • createExtensionApiByAlias<ApiType extends UmbApi = UmbApi>(
        host: UmbControllerHost,
        alias: string,
        constructorArgs?: unknown[],
    ): Promise<ApiType>

    Type Parameters

    • ApiType extends UmbApi = UmbApi

    Parameters

    • host: UmbControllerHost

      The host to parse on as the host to the extension api.

    • alias: string

      The alias of the extension api to create.

    • OptionalconstructorArgs: unknown[]

      The constructor arguments to pass to the extension api, host will always be appended as the first argument, meaning these arguments will be second and so forth.

    Returns Promise<ApiType>

    a class instance of the api provided via the manifest that matches the given alias. You have to type this via the generic ApiType parameter.

    • Defined in src/packages/core/extension-registry/utils/create-extension-api-by-alias.function.ts:12

Settings

Member Visibility
@umbraco-cms/backoffice
  • Loading...

Generated using TypeDoc