• Preparing search index...
  • The search index is not available
@umbraco-cms/backoffice
  • @umbraco-cms/backoffice
  • libs/extension-api
  • createExtensionApi

Function createExtensionApi

  • createExtensionApi<ApiType extends UmbApi = UmbApi>(
        host: UmbControllerHost,
        manifest: ManifestApi<ApiType> | ManifestElementAndApi<any, ApiType>,
        constructorArgs?:
            | unknown[]
            | UmbApiConstructorArgumentsMethodType<
                ManifestApi<ApiType>
                | ManifestElementAndApi<any, ApiType>,
            >,
    ): Promise<undefined | ApiType>

    Type Parameters

    • ApiType extends UmbApi = UmbApi

    Parameters

    • host: UmbControllerHost

      The controller host for this controller to be appended to

    • manifest: ManifestApi<ApiType> | ManifestElementAndApi<any, ApiType>

      The manifest of the extension

    • OptionalconstructorArgs:
          | unknown[]
          | UmbApiConstructorArgumentsMethodType<
              ManifestApi<ApiType>
              | ManifestElementAndApi<any, ApiType>,
          >

      The constructor arguments to pass to the API class

    Returns Promise<undefined | ApiType>

    • The API class instance
    • Defined in src/libs/extension-api/functions/create-extension-api.function.ts:13

Settings

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

Generated using TypeDoc