doc: add docment and example for byte.go

formatter/byte.go

@@ -93,7 +93,7 @@ func DecimalBytes(size float64, precision ...int) string {
 	return fmt.Sprintf("%.*g%s", p, size, unit)
 }
 
-// BinaryBytes returns a human-readable byte size under decimal standard (base 1024)
+// BinaryBytes returns a human-readable byte size under binary standard (base 1024)
 // The precision parameter specifies the number of digits after the decimal point, which defaults to 4.
 // Play: todo
 func BinaryBytes(size float64, precision ...int) string {
@@ -116,14 +116,14 @@ func calculateByteSize(size float64, base float64, byteUnits []string) (float64,
 	return size, byteUnits[i]
 }
 
-// ParseDecimalBytes the human readable bytes size string into the amount it represents(base 1000).
+// ParseDecimalBytes return the human readable bytes size string into the amount it represents(base 1000).
 // ParseDecimalBytes("42 MB") -> 42000000, nil
 // Play: todo
 func ParseDecimalBytes(size string) (uint64, error) {
 	return parseBytes(size, "decimal")
 }
 
-// ParseBinaryBytes the human readable bytes size string into the amount it represents(base 1024).
+// ParseBinaryBytes return the human readable bytes size string into the amount it represents(base 1024).
 // ParseBinaryBytes("42 mib") -> 44040192, nil
 // Play: todo
 func ParseBinaryBytes(size string) (uint64, error) {

formatter/formatter_example_test.go

@@ -59,3 +59,75 @@ func ExamplePrettyToWriter() {
 	//
 	// <nil>
 }
+
+func ExampleDecimalBytes() {
+	result1 := DecimalBytes(1000)
+	result2 := DecimalBytes(1024)
+	result3 := DecimalBytes(1234567)
+	result4 := DecimalBytes(1234567, 3)
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+	fmt.Println(result4)
+
+	// Output:
+	// 1KB
+	// 1.024KB
+	// 1.2346MB
+	// 1.235MB
+}
+
+func ExampleBinaryBytes() {
+	result1 := BinaryBytes(1024)
+	result2 := BinaryBytes(1024 * 1024)
+	result3 := BinaryBytes(1234567)
+	result4 := BinaryBytes(1234567, 2)
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+	fmt.Println(result4)
+
+	// Output:
+	// 1KiB
+	// 1MiB
+	// 1.1774MiB
+	// 1.18MiB
+}
+
+func ExampleParseDecimalBytes() {
+	result1, _ := ParseDecimalBytes("12")
+	result2, _ := ParseDecimalBytes("12k")
+	result3, _ := ParseDecimalBytes("12 Kb")
+	result4, _ := ParseDecimalBytes("12.2 kb")
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+	fmt.Println(result4)
+
+	// Output:
+	// 12
+	// 12000
+	// 12000
+	// 12200
+}
+
+func ExampleParseBinaryBytes() {
+	result1, _ := ParseBinaryBytes("12")
+	result2, _ := ParseBinaryBytes("12ki")
+	result3, _ := ParseBinaryBytes("12 KiB")
+	result4, _ := ParseBinaryBytes("12.2 kib")
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+	fmt.Println(result4)
+
+	// Output:
+	// 12
+	// 12288
+	// 12288
+	// 12492
+}