From 711191486e1b8fd1d19f94767f577b42a98dc2ef Mon Sep 17 00:00:00 2001 From: Mads Rasmussen Date: Mon, 29 Apr 2024 21:24:27 +0200 Subject: [PATCH] add js docs --- .../repository/dynamic-root.repository.ts | 14 ++++++++++++++ .../repository/dynamic-root.server.data.ts | 11 +++++++++++ 2 files changed, 25 insertions(+) diff --git a/src/Umbraco.Web.UI.Client/src/packages/property-editors/content-picker/dynamic-root/repository/dynamic-root.repository.ts b/src/Umbraco.Web.UI.Client/src/packages/property-editors/content-picker/dynamic-root/repository/dynamic-root.repository.ts index b8665f0441..e0f8e1a9af 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/property-editors/content-picker/dynamic-root/repository/dynamic-root.repository.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/property-editors/content-picker/dynamic-root/repository/dynamic-root.repository.ts @@ -6,6 +6,12 @@ import type { DynamicRootRequestModel } from '@umbraco-cms/backoffice/external/b const GUID_EMPTY: string = '00000000-0000-0000-0000-000000000000'; +/** + * UmbContentPickerDynamicRootRepository + * @export + * @class UmbContentPickerDynamicRootRepository + * @extends {UmbControllerBase} + */ export class UmbContentPickerDynamicRootRepository extends UmbControllerBase { #dataSource: UmbContentPickerDynamicRootServerDataSource; @@ -15,6 +21,14 @@ export class UmbContentPickerDynamicRootRepository extends UmbControllerBase { this.#dataSource = new UmbContentPickerDynamicRootServerDataSource(host); } + /** + * Request dynamic root + * @param {UmbContentPickerDynamicRoot} query + * @param {string} entityId + * @param {string} [parentId] + * @return {*} + * @memberof UmbContentPickerDynamicRootRepository + */ async requestRoot(query: UmbContentPickerDynamicRoot, entityId: string, parentId?: string) { const model: DynamicRootRequestModel = { context: { diff --git a/src/Umbraco.Web.UI.Client/src/packages/property-editors/content-picker/dynamic-root/repository/dynamic-root.server.data.ts b/src/Umbraco.Web.UI.Client/src/packages/property-editors/content-picker/dynamic-root/repository/dynamic-root.server.data.ts index 9d0a3a166d..2e19b051e8 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/property-editors/content-picker/dynamic-root/repository/dynamic-root.server.data.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/property-editors/content-picker/dynamic-root/repository/dynamic-root.server.data.ts @@ -3,6 +3,11 @@ import { tryExecuteAndNotify } from '@umbraco-cms/backoffice/resources'; import type { DynamicRootRequestModel, DynamicRootResponseModel } from '@umbraco-cms/backoffice/external/backend-api'; import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api'; +/** + * UmbContentPickerDynamicRootServerDataSource + * @export + * @class UmbContentPickerDynamicRootServerDataSource + */ export class UmbContentPickerDynamicRootServerDataSource { #host: UmbControllerHost; @@ -10,6 +15,12 @@ export class UmbContentPickerDynamicRootServerDataSource { this.#host = host; } + /** + * Get dynamic root + * @param {DynamicRootRequestModel} args + * @return {*} {(Promise)} + * @memberof UmbContentPickerDynamicRootServerDataSource + */ async getRoot(args: DynamicRootRequestModel): Promise { if (!args.context) throw new Error('Dynamic Root context is missing'); if (!args.query) throw new Error('Dynamic Root query is missing');