docs(domain): add JSDoc to explain why prefer to use record instead o… (

#451) * docs(domain): add JSDoc to explain why prefer to use record instead of value domain Co-authored-by: Teddy Paul <TdyP@users.noreply.github.com>
leav-solutions · Apr 12, 2024 · 6b3e727 · 6b3e727
1 parent 7c84c65
commit 6b3e727
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 2 deletions.
diff --git a/apps/core/src/domain/record/recordDomain.ts b/apps/core/src/domain/record/recordDomain.ts
@@ -123,7 +123,25 @@ export interface IRecordDomain {
      */
     find({params, ctx}: {params: IFindRecordParams; ctx: IQueryInfos}): Promise<IListWithCursor<IRecord>>;
 
-    getRecordFieldValue(params: {
+    /**
+     * Get the value of targeted attribute with actions applied on it including metadata.
+     *
+     * Avoid requesting DB if attribute already found in `record` param.
+     *
+     * @param {Object} params
+     * @param params.library
+     * @param params.record Could be emulated with only `{ id: <real_id> }`
+     * @param params.attributeId
+     * @param params.options
+     * @param params.ctx
+     */
+    getRecordFieldValue({
+        library,
+        record,
+        attributeId,
+        options,
+        ctx
+    }: {
         library: string;
         record: IRecord;
         attributeId: string;
@@ -758,7 +776,7 @@ export default function ({
             });
 
             if (treeValues.length) {
-                // for now we look through first element (discard others if linked to multiple leaves of tree)
+                // for now, we look through first element (discard others if linked to multiple leaves of tree)
                 const treeAttrProps = await attributeDomain.getAttributeProperties({id: conf.treeColorPreview, ctx});
                 const ancestors = await treeRepo.getElementAncestors({
                     treeId: treeAttrProps.linked_tree,

diff --git a/apps/core/src/domain/value/valueDomain.ts b/apps/core/src/domain/value/valueDomain.ts
@@ -49,6 +49,17 @@ export interface ISaveBatchValueResult {
 }
 
 export interface IValueDomain {
+    /**
+     * Call DB to get the value of an attribute.
+     * Prefer to use `recordDomain.getRecordFieldValue()` which is more optimized in certain situations.
+     *
+     * @param {Object} params
+     * @param params.library
+     * @param params.recordId
+     * @param params.attribute
+     * @param params.options
+     * @param params.ctx
+     */
     getValues({
         library,
         recordId,