Skip to content
This repository was archived by the owner on Nov 6, 2025. It is now read-only.

Commit 4b0b012

Browse files
committed
JSDocs
1 parent 8852f89 commit 4b0b012

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/packages/documents/documents/workspace/document-workspace.context.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -418,9 +418,9 @@ export class UmbDocumentWorkspaceContext
418418

419419
/**
420420
* @function propertyValueByAlias
421-
* @param {string} propertyAlias
422-
* @param {UmbVariantId} variantId
423-
* @returns {Promise<Observable<ReturnType | undefined> | undefined>}
421+
* @param {string} propertyAlias - The alias of the property
422+
* @param {UmbVariantId} variantId - The variant
423+
* @returns {Promise<Observable<ReturnType | undefined> | undefined>} - An observable for the value of the property
424424
* @description Get an Observable for the value of this property.
425425
*/
426426
async propertyValueByAlias<PropertyValueType = unknown>(
@@ -436,9 +436,9 @@ export class UmbDocumentWorkspaceContext
436436

437437
/**
438438
* Get the current value of the property with the given alias and variantId.
439-
* @param alias
440-
* @param variantId
441-
* @returns The value or undefined if not set or found.
439+
* @param {string} alias - The alias of the property
440+
* @param {UmbVariantId | undefined} variantId - The variant id of the property
441+
* @returns {ReturnType | undefined} The value or undefined if not set or found.
442442
*/
443443
getPropertyValue<ReturnType = unknown>(alias: string, variantId?: UmbVariantId) {
444444
const currentData = this.#data.getCurrent();

0 commit comments

Comments
 (0)