viem 1.19.1 → 1.19.4

package/utils/unit/formatUnits.ts

@@ -2,6 +2,17 @@ import type { ErrorType } from '../../errors/utils.js'
 
 export type FormatUnitsErrorType = ErrorType
 
+/**
+ *  Divides a number by a given exponent of base 10 (10exponent), and formats it into a string representation of the number..
+ *
+ * - Docs: https://viem.sh/docs/utilities/formatUnits.html
+ *
+ * @example
+ * import { formatUnits } from 'viem'
+ *
+ * formatUnits(420000000000n, 9)
+ * // '420'
+ */
 export function formatUnits(value: bigint, decimals: number) {
   let display = value.toString()
 

package/utils/unit/parseEther.ts

@@ -5,6 +5,17 @@ import { type ParseUnitsErrorType, parseUnits } from './parseUnits.js'
 
 export type ParseEtherErrorType = ParseUnitsErrorType | ErrorType
 
+/**
+ * Converts a string representation of ether to numerical wei.
+ *
+ * - Docs: https://viem.sh/docs/utilities/parseEther.html
+ *
+ * @example
+ * import { parseEther } from 'viem'
+ *
+ * parseEther('420')
+ * // 420000000000000000000n
+ */
 export function parseEther(ether: string, unit: 'wei' | 'gwei' = 'wei') {
   return parseUnits(ether, etherUnits[unit])
 }

package/utils/unit/parseGwei.ts

@@ -5,6 +5,17 @@ import { type ParseUnitsErrorType, parseUnits } from './parseUnits.js'
 
 export type ParseGweiErrorType = ParseUnitsErrorType | ErrorType
 
+/**
+ * Converts a string representation of gwei to numerical wei.
+ *
+ * - Docs: https://viem.sh/docs/utilities/parseGwei.html
+ *
+ * @example
+ * import { parseGwei } from 'viem'
+ *
+ * parseGwei('420')
+ * // 420000000000n
+ */
 export function parseGwei(ether: string, unit: 'wei' = 'wei') {
   return parseUnits(ether, gweiUnits[unit])
 }

package/utils/unit/parseUnits.ts

@@ -2,6 +2,17 @@ import type { ErrorType } from '../../errors/utils.js'
 
 export type ParseUnitsErrorType = ErrorType
 
+/**
+ * Multiplies a string representation of a number by a given exponent of base 10 (10exponent).
+ *
+ * - Docs: https://viem.sh/docs/utilities/parseUnits.html
+ *
+ * @example
+ * import { parseUnits } from 'viem'
+ *
+ * parseUnits('420', 9)
+ * // 420000000000n
+ */
 export function parseUnits(value: string, decimals: number) {
   let [integer, fraction = '0'] = value.split('.')