add doc

microsoft · Oct 18, 2024 · 47e30a3 · 47e30a3
1 parent 9a238bc
commit 47e30a3
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/packages/http/src/decorators.ts b/packages/http/src/decorators.ts
@@ -156,7 +156,13 @@ export function getCookieParamOptions(
   return program.stateMap(HttpStateKeys.cookie).get(entity);
 }
 
-export function isCookieParam(program: Program, entity: Type) {
+/**
+ * Check whether the given entity is a cookie parameter.
+ * @param program
+ * @param entity
+ * @returns True if the entity is a cookie parameter, false otherwise.
+ */
+export function isCookieParam(program: Program, entity: Type): boolean {
   return program.stateMap(HttpStateKeys.cookie).has(entity);
 }