docs - Branch - hckhanh/vn-number

Enhance README and initialize documentation foundation

#46Merged

Comparing

docs

(

937b31c

) with

main

(

014b6b1

)

Untouched: 64

Benchmarks

Passed

display e-commerce product card

src/format/number.bench.ts::real-world application scenarios

41.1 µs40.9 µs

format large contract (15,000,000,000 VND)

src/format/number.bench.ts::formatVnCurrency - typical usage scenarios

28.2 µs28.1 µs

format complete product listing (30 products)

src/format/number.bench.ts::combined operations - real-world scenarios

43.8 µs43.6 µs

format small price (15,000 VND)

src/format/number.bench.ts::formatVnCurrency - typical usage scenarios

29.8 µs29.7 µs

format all three types together (typical dashboard row)

src/format/number.bench.ts::combined operations - real-world scenarios

35.7 µs35.6 µs

display shopping cart (5 items with quantities)

src/read/index.bench.ts::readVnNumber - real-world application scenarios

170.6 µs170.1 µs

format 50 financial amounts (1M-10B VND)

src/format/number.bench.ts::formatVnCurrency - realistic batch operations

34.1 µs34 µs

format annual budget (2,500,000,000 VND)

src/format/number.bench.ts::formatVnCurrency - typical usage scenarios

28.2 µs28.1 µs

format monthly revenue (125,000,000 VND)

src/format/number.bench.ts::formatVnCurrency - typical usage scenarios

28 µs27.9 µs

format decimal amount (199,000.50 VND)

src/format/number.bench.ts::formatVnCurrency - typical usage scenarios

30.2 µs30.1 µs

format typical product price (199,000 VND)

src/format/number.bench.ts::formatVnCurrency - typical usage scenarios

29.9 µs29.9 µs

format 50 invoice totals (100k-100M VND)

src/format/number.bench.ts::formatVnCurrency - realistic batch operations

33.3 µs33.2 µs

display invoice (10 line items)

src/format/number.bench.ts::real-world application scenarios

54.5 µs54.4 µs

read 50 invoice totals (100k-100M VND)

src/read/index.bench.ts::readVnNumber - realistic batch operations

62.1 µs62.1 µs

annual revenue (2,500,000,000 VND)

src/read/index.bench.ts::readVnNumber - typical usage scenarios

53.7 µs53.6 µs

display product catalog (20 products)

src/format/number.bench.ts::real-world application scenarios

53.8 µs53.8 µs

read 50 product quantities (1-100)

src/read/index.bench.ts::readVnNumber - realistic batch operations

50.1 µs50.1 µs

read 50 e-commerce prices (10k-50M VND)

src/read/index.bench.ts::readVnNumber - realistic batch operations

61.7 µs61.6 µs

transaction amount (19,990,000 VND)

src/read/index.bench.ts::readVnNumber - typical usage scenarios

52.9 µs52.8 µs

read 50 financial amounts (1M-10B VND)

src/read/index.bench.ts::readVnNumber - realistic batch operations

71 µs70.9 µs

product quantity (5 items)

src/read/index.bench.ts::readVnNumber - typical usage scenarios

66.7 µs66.6 µs

format invoice total (5,450,000 VND)

src/format/number.bench.ts::formatVnCurrency - typical usage scenarios

29.2 µs29.2 µs

formatVnCurrency with different input types

src/format/number.bench.ts::input type variations - real-world scenarios

48 µs47.9 µs

format 50 product quantities

src/format/number.bench.ts::formatVnNumber - realistic batch operations

32 µs31.9 µs

format 50 order counts

src/format/number.bench.ts::formatVnNumber - realistic batch operations

32.4 µs32.4 µs

invoice total (5,450,000 VND)

src/read/index.bench.ts::readVnNumber - typical usage scenarios

57.7 µs57.7 µs

display financial dashboard (weekly metrics)

src/format/number.bench.ts::real-world application scenarios

165 µs164.8 µs

display shopping cart (5 items)

src/format/number.bench.ts::real-world application scenarios

120.5 µs120.4 µs

typical product price (199,000 VND)

src/read/index.bench.ts::readVnNumber - typical usage scenarios

64.6 µs64.5 µs

display data table (50 rows × 6 columns)

src/format/number.bench.ts::real-world application scenarios

50.5 µs50.5 µs

display financial dashboard (20 metrics)

src/read/index.bench.ts::readVnNumber - real-world application scenarios

897.7 µs897.2 µs

formatVnNumber with different input types

src/format/number.bench.ts::input type variations - real-world scenarios

45.4 µs45.4 µs

mixed input types in data processing (30 values)

src/read/index.bench.ts::readVnNumber - input type variations

582.5 µs582.3 µs

display sales report (monthly performance)

src/format/number.bench.ts::real-world application scenarios

626.9 µs626.9 µs

format decimal value (12,345.67)

src/format/number.bench.ts::formatVnNumber - typical usage scenarios

29.5 µs29.5 µs

format 50 e-commerce prices (10k-50M VND)

src/format/number.bench.ts::formatVnCurrency - realistic batch operations

33.3 µs33.3 µs

bigint input (large transaction)

src/read/index.bench.ts::readVnNumber - input type variations

40.3 µs40.3 µs

format conversion rate (2.5%)

src/format/number.bench.ts::formatVnPercent - typical usage scenarios

28.6 µs28.6 µs

format 50 conversion rates (0-10%)

src/format/number.bench.ts::formatVnPercent - realistic batch operations

33.3 µs33.3 µs

format growth rate (25%)

src/format/number.bench.ts::formatVnPercent - typical usage scenarios

28.1 µs28.1 µs

format 50 growth rates (-50% to +150%)

src/format/number.bench.ts::formatVnPercent - realistic batch operations

33.7 µs33.7 µs

string input (from API/form)

src/read/index.bench.ts::readVnNumber - input type variations

46.3 µs46.3 µs

format transaction amount (19,990,000 VND)

src/format/number.bench.ts::formatVnCurrency - typical usage scenarios

33.7 µs33.7 µs

display payment summary

src/format/number.bench.ts::real-world application scenarios

43.2 µs43.2 µs

display invoice line items (10 items)

src/read/index.bench.ts::readVnNumber - real-world application scenarios

74.9 µs74.9 µs

mixed input types in data processing (30 values)

src/format/number.bench.ts::input type variations - real-world scenarios

138.4 µs138.5 µs

large contract value (15,000,000,000 VND)

src/read/index.bench.ts::readVnNumber - typical usage scenarios

49.2 µs49.3 µs

number input (typical price)

src/read/index.bench.ts::readVnNumber - input type variations

42.7 µs42.8 µs

format negative value (-5,432)

src/format/number.bench.ts::formatVnNumber - typical usage scenarios

28.6 µs28.7 µs

format 50 completion rates (0-100%)

src/format/number.bench.ts::formatVnPercent - realistic batch operations

33.1 µs33.1 µs

formatVnPercent with different input types

src/format/number.bench.ts::input type variations - real-world scenarios

42 µs42 µs

format user count (5,432,100)

src/format/number.bench.ts::formatVnNumber - typical usage scenarios

28.6 µs28.7 µs

format total sales (125,678)

src/format/number.bench.ts::formatVnNumber - typical usage scenarios

28.6 µs28.6 µs

format order count (1,234)

src/format/number.bench.ts::formatVnNumber - typical usage scenarios

28.4 µs28.5 µs

display product catalog (20 products)

src/read/index.bench.ts::readVnNumber - real-world application scenarios

65.1 µs65.2 µs

format interest rate (5.5%)

src/format/number.bench.ts::formatVnPercent - typical usage scenarios

28.6 µs28.6 µs

format negative change (-10%)

src/format/number.bench.ts::formatVnPercent - typical usage scenarios

28.2 µs28.3 µs

format completion rate (75%)

src/format/number.bench.ts::formatVnPercent - typical usage scenarios

28.2 µs28.2 µs

display payment receipt (typical transaction)

src/read/index.bench.ts::readVnNumber - real-world application scenarios

61.1 µs61.2 µs

format discount rate (15%)

src/format/number.bench.ts::formatVnPercent - typical usage scenarios

28.7 µs28.7 µs

format small percentage (0.5%)

src/format/number.bench.ts::formatVnPercent - typical usage scenarios

28.6 µs28.7 µs

format over target (125%)

src/format/number.bench.ts::formatVnPercent - typical usage scenarios

28.2 µs28.3 µs

format full completion (100%)

src/format/number.bench.ts::formatVnPercent - typical usage scenarios

27.3 µs27.4 µs

format product quantity (15)

src/format/number.bench.ts::formatVnNumber - typical usage scenarios

36.8 µs36.9 µs

Commits

Click on a commit to change the comparison range

Base

main

014b6b1

+0.04%

Update README and expand API documentation Revised the README file to improve clarity, consistency, and grammar. Added new sections in the API documentation covering installation, usage examples, and Vietnamese language rules. Updated dependencies and included `vn-number` for better integration.

a932273

11 days ago

by hckhanh

Add dynamic `ReadVnNumber` component and update docs Introduced `ReadVnNumber` component for interactive Vietnamese number reading example. Replaced tab-based code samples with dynamic input field for better user engagement. Adjusted Biome configuration and updated class ordering in layout for consistency.

937b31c

11 days ago

by hckhanh

Home Terms Privacy Docs