add js docs

This commit is contained in:
Mads Rasmussen
2024-04-29 21:24:27 +02:00
parent 682a8a3649
commit 711191486e
2 changed files with 25 additions and 0 deletions

View File

@@ -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: {

View File

@@ -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<DynamicRootResponseModel | undefined>)}
* @memberof UmbContentPickerDynamicRootServerDataSource
*/
async getRoot(args: DynamicRootRequestModel): Promise<DynamicRootResponseModel | undefined> {
if (!args.context) throw new Error('Dynamic Root context is missing');
if (!args.query) throw new Error('Dynamic Root query is missing');