feat(hub-common): added comments

affects: @esri/hub-common
Esri · Mar 6, 2024 · 9923f7e · 9923f7e
1 parent c9a61b6
commit 9923f7e
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/packages/common/src/search/_internal/hubSearchItemsHelpers/ogcItemToDiscussionPostResult.ts b/packages/common/src/search/_internal/hubSearchItemsHelpers/ogcItemToDiscussionPostResult.ts
@@ -2,6 +2,14 @@ import { IOgcItem } from "./interfaces";
 import { IPost } from "../../../discussions";
 import { IHubSearchResult } from "../../types";
 
+/**
+ * This method is responsible for converting an OGC item whose properties
+ * represent an IPost into an IHubSearchResult. Although some fields do not
+ * apply, this is being done such that result of a discussion post search
+ * can automatically be used in a gallery.
+ * @param ogcItem
+ * @returns IHubSearchResult
+ */
 export async function ogcItemToDiscussionPostResult(
   ogcItem: IOgcItem
 ): Promise<IHubSearchResult> {