From c96d5fd2b2f658fda8db2b93ff35b752eb26c203 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Niels=20Lyngs=C3=B8?= Date: Tue, 5 Nov 2024 10:47:11 +0100 Subject: [PATCH] jsdocs updates --- .../content-detail-workspace-base.ts | 27 ++++++++++--------- 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/content/workspace/content-detail-workspace-base.ts b/src/Umbraco.Web.UI.Client/src/packages/core/content/workspace/content-detail-workspace-base.ts index dd905fd88a..f097a97ddf 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/content/workspace/content-detail-workspace-base.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/content/workspace/content-detail-workspace-base.ts @@ -93,6 +93,9 @@ export abstract class UmbContentDetailWorkspaceContextBase< /* Data Type */ readonly #dataTypeItemManager = new UmbDataTypeItemRepositoryManager(this); + /** + * Data Type Schema Map is used for lookup, this should make coder simpler and give better performance. [NL] + */ #dataTypeSchemaAliasMap = new Map(); #varies?: boolean; @@ -210,7 +213,7 @@ export abstract class UmbContentDetailWorkspaceContextBase< this.observe( this.#dataTypeItemManager.items, (dataTypes) => { - // Make a map of the data type unique and editorAlias: + // Make a map of the data type unique and editorAlias this.#dataTypeSchemaAliasMap = new Map( dataTypes.map((dataType) => { return [dataType.unique, dataType.propertyEditorSchemaAlias]; @@ -233,7 +236,7 @@ export abstract class UmbContentDetailWorkspaceContextBase< * Get the name of a variant * @param {UmbVariantId } [variantId] - The variant id * @returns { string | undefined} - The name of the variant - * @memberof UmbContentDetailWorkspaceBase + * @memberof UmbContentDetailWorkspaceContextBase */ public getName(variantId?: UmbVariantId): string | undefined { const variants = this._data.getCurrent()?.variants; @@ -249,7 +252,7 @@ export abstract class UmbContentDetailWorkspaceContextBase< * Set the name of a variant * @param {string} name - The name of the variant * @param {UmbVariantId} [variantId] - The variant id - * @memberof UmbContentDetailWorkspaceBase + * @memberof UmbContentDetailWorkspaceContextBase */ public setName(name: string, variantId?: UmbVariantId): void { // eslint-disable-next-line @typescript-eslint/ban-ts-comment @@ -262,7 +265,7 @@ export abstract class UmbContentDetailWorkspaceContextBase< * Get an observable for the name of a variant * @param {UmbVariantId} [variantId] - The variant id * @returns {Observable} - The name of the variant - * @memberof UmbContentDetailWorkspaceBase + * @memberof UmbContentDetailWorkspaceContextBase */ public name(variantId?: UmbVariantId): Observable { return this._data.createObservablePartOfCurrent( @@ -275,7 +278,7 @@ export abstract class UmbContentDetailWorkspaceContextBase< /** * Get whether the content varies by culture * @returns { boolean | undefined } - If the content varies by culture - * @memberof UmbContentDetailWorkspaceBase + * @memberof UmbContentDetailWorkspaceContextBase */ public getVariesByCulture(): boolean | undefined { return this.#variesByCulture; @@ -284,7 +287,7 @@ export abstract class UmbContentDetailWorkspaceContextBase< /** * Get whether the content varies by segment * @returns {boolean | undefined} - If the content varies by segment - * @memberof UmbContentDetailWorkspaceBase + * @memberof UmbContentDetailWorkspaceContextBase */ public getVariesBySegment(): boolean | undefined { return this.#variesBySegment; @@ -293,7 +296,7 @@ export abstract class UmbContentDetailWorkspaceContextBase< /** * Get whether the content varies * @returns { boolean | undefined } - If the content varies - * @memberof UmbContentDetailWorkspaceBase + * @memberof UmbContentDetailWorkspaceContextBase */ public getVaries(): boolean | undefined { return this.#varies; @@ -303,7 +306,7 @@ export abstract class UmbContentDetailWorkspaceContextBase< * Get the variant by the given variantId * @param {UmbVariantId} variantId - The variant id * @returns { Observable } - The variant or undefined if not found - * @memberof UmbContentDetailWorkspaceBase + * @memberof UmbContentDetailWorkspaceContextBase */ public variantById(variantId: UmbVariantId): Observable { return this._data.createObservablePartOfCurrent((data) => data?.variants?.find((x) => variantId.compare(x))); @@ -313,7 +316,7 @@ export abstract class UmbContentDetailWorkspaceContextBase< * Get the variant by the given variantId * @param {UmbVariantId} variantId - The variant id * @returns { VariantModelType | undefined } - The variant or undefined if not found - * @memberof UmbContentDetailWorkspaceBase + * @memberof UmbContentDetailWorkspaceContextBase */ public getVariant(variantId: UmbVariantId): VariantModelType | undefined { return this._data.getCurrent()?.variants?.find((x) => variantId.compare(x)); @@ -323,7 +326,7 @@ export abstract class UmbContentDetailWorkspaceContextBase< * Observe the property type * @param {string} propertyId - The id of the property * @returns {Promise>} - An observable for the property type - * @memberof UmbContentDetailWorkspaceBase + * @memberof UmbContentDetailWorkspaceContextBase */ public async propertyStructureById(propertyId: string): Promise> { return this.structure.propertyStructureById(propertyId); @@ -334,7 +337,7 @@ export abstract class UmbContentDetailWorkspaceContextBase< /** * Get the values of the content * @returns {Array | undefined} - The values of the content - * @memberof UmbContentDetailWorkspaceBase + * @memberof UmbContentDetailWorkspaceContextBase */ public getValues(): Array | undefined { return this._data.getCurrent()?.values; @@ -381,7 +384,7 @@ export abstract class UmbContentDetailWorkspaceContextBase< * @param {string} alias - The alias of the property * @param {ValueType} value - The value to set * @param {UmbVariantId} [variantId] - The variant id of the property - * @memberof UmbContentDetailWorkspaceBase + * @memberof UmbContentDetailWorkspaceContextBase */ public async setPropertyValue(alias: string, value: ValueType, variantId?: UmbVariantId) { this.initiatePropertyValueChange();