@open-xamu-co/ui-common-types 4.0.0-next.1 → 4.0.0-next.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xamu-co/ui-common-types",
-  "version": "4.0.0-next.1",
+  "version": "4.0.0-next.2",
   "description": "Xamu shared types",
   "author": "@xamu-co",
   "main": "src/index.ts",

package/src/fetch.ts

@@ -3,28 +3,44 @@ export type tOrder = "desc" | "asc";
 /**
  * Order using column or property
  *
- * @example [["id", "asc" ]], order ascendente de id
- * @example [["id", "desc" ]] or [["id"]], order descendente de id
+ * @example ["id", "asc" ], order ascendente de id
+ * @example ["id", "desc" ] or ["id"], order descendente de id
  */
 export type tOrderBy = [string, tOrder?];
 
 export interface iPageEdge<T, C extends string | number = string> {
 	cursor: C;
+	/** Node data */
 	node: T;
 }
 
 export interface iPageInfo<C extends string | number = string> {
 	nextCursor?: C;
 	previousCursor?: C;
+	/**
+	 * Current page number
+	 * According to the "at" and "first" parameters
+	 */
 	pageNumber?: number;
+	/** There is a next page */
 	hasNextPage: boolean;
+	/** There is a previous page */
 	hasPreviousPage: boolean;
+	/** Current page path */
 	path?: string;
 }
 
 export interface iPage<T, C extends string | number = string> {
+	/**
+	 * List of nodes with cursor data for the current page
+	 * Amount of nodes is limited by the "first" parameter
+	 */
 	edges: iPageEdge<T, C>[];
 	pageInfo: iPageInfo<C>;
+	/**
+	 * Count of nodes matching the path
+	 * Independent of pagination
+	 */
 	totalCount: number;
 }
 
@@ -39,6 +55,12 @@ export interface iPagination {
 	 * Cantidad de elementos por pagina (limite)
 	 */
 	first?: number;
+	/**
+	 * Order using column or property
+	 *
+	 * @example [["id", "asc" ]], order ascendente de id
+	 * @example [["id", "desc" ]] or [["id"]], order descendente de id
+	 */
 	orderBy?: tOrderBy[];
 }