add ts-doc comments

meetulr · Nov 2, 2024 · 0592e41 · 0592e41
1 parent c6863d0
commit 0592e41
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 9 deletions.
diff --git a/src/utilities/userTagsPaginationUtils/parseUserTagMemberWhere.ts b/src/utilities/userTagsPaginationUtils/parseUserTagMemberWhere.ts
@@ -4,15 +4,17 @@ import type {
   ParseGraphQLConnectionWhereResult,
 } from "../graphQLConnection";
 
-/*
- * function to parse the args.where for UserTag member assignment queries
+/**
+ * type of the where object returned if the parsing is successful
  */
-
 export type ParseUserTagMemberWhereResult = {
   firstNameStartsWith: string;
   lastNameStartsWith: string;
 };
 
+/**
+ * function to parse the args.where for UserTag member assignment queries
+ */
 export function parseUserTagMemberWhere(
   where: UserTagUsersAssignedToWhereInput | null | undefined,
 ): ParseGraphQLConnectionWhereResult<ParseUserTagMemberWhereResult> {

diff --git a/src/utilities/userTagsPaginationUtils/parseUserTagSortedBy.ts b/src/utilities/userTagsPaginationUtils/parseUserTagSortedBy.ts
@@ -7,14 +7,16 @@ import type {
   ParseGraphQLConnectionSortedByResult,
 } from "../graphQLConnection";
 
-/*
- * function to parse the args.sortedBy for UserTag queries
+/**
+ * type of the sort object returned if the parsing is successful
  */
-
 export type ParseSortedByResult = {
   sortById: SortedByOrder;
 };
 
+/**
+ * function to parse the args.sortedBy for UserTag queries
+ */
 export function parseUserTagSortedBy(
   sortedBy: UserTagSortedByInput | null | undefined,
 ): ParseGraphQLConnectionSortedByResult<ParseSortedByResult> {

diff --git a/src/utilities/userTagsPaginationUtils/parseUserTagWhere.ts b/src/utilities/userTagsPaginationUtils/parseUserTagWhere.ts
@@ -4,14 +4,16 @@ import type {
   ParseGraphQLConnectionWhereResult,
 } from "../graphQLConnection";
 
-/*
- * function to parse the args.where for UserTag queries
+/**
+ * type of the where object returned if the parsing is successful
  */
-
 export type ParseUserTagWhereResult = {
   nameStartsWith: string;
 };
 
+/**
+ * function to parse the args.where for UserTag queries
+ */
 export function parseUserTagWhere(
   where: UserTagWhereInput | null | undefined,
 ): ParseGraphQLConnectionWhereResult<ParseUserTagWhereResult> {