chore: add docs

Author: 1cedrus

packages/typink/src/utils/formatBalance.ts

@@ -5,10 +5,22 @@ export interface FormatBalanceOptions {
   symbol?: string;
 }
 
+// More specific information for the function
+
+/**
+ * Format a balance value to a human-readable string.
+ *
+ * @param value - The balance value.
+ * @param options - The formatting options.
+ * @param options.decimals - The decimals of network.
+ * @param options.symbol - The currency symbol.
+ *
+ * @returns The formatted balance.
+ */
 export function formatBalance(value: number | bigint | string | undefined, options: FormatBalanceOptions): string {
   if (value === undefined) {
     return '';
-  } 
+  }
 
   const { decimals = 0, symbol } = options;