From d8ee331b9987b12ec27bb424591eedda7afbc3e3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Niels=20Lyngs=C3=B8?= Date: Thu, 9 Nov 2023 09:54:13 +0100 Subject: [PATCH] JSDocs --- .../controller/extensions-api-controller.ts | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/extensions-api-controller.ts b/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/extensions-api-controller.ts index 6ef7c52bc8..c44440b914 100644 --- a/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/extensions-api-controller.ts +++ b/src/Umbraco.Web.UI.Client/src/libs/extension-api/controller/extensions-api-controller.ts @@ -10,6 +10,16 @@ import { import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api'; /** + * This Controller manages a set of Extensions and their Manifest. + * When one or more extensions is permitted to be used, the callback gives all permitted extensions and their manifest. + * + * @example +* ```ts +TODO: Correct this, start using builder pattern: +* const controller = new UmbExtensionsApiController(host, extensionRegistry, type, ['constructor argument 1', 'constructor argument '], filter?, (permitted, ctrl) => { console.log("Extension is permitted and this is the manifest: ", ctrl.manifest) })); +* ``` + * @export + * @class UmbExtensionsApiController */ export class UmbExtensionsApiController< ManifestTypes extends ManifestApi,