Skip to content

Commit

Permalink
Update README, refine function docs and bump up version number
Browse files Browse the repository at this point in the history
This commit updates the README file to include new features and functions. The code comments/documentation for readVnNumber function have also been revised for clarity. Additionally, the version number in deno.json has been incremented to reflect the changes made.
  • Loading branch information
hckhanh committed Feb 26, 2024
1 parent b8babaf commit 657b163
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 9 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,9 @@ A bunch of utility functions that work with number in Vietnamese language

## Features

- Zero dependencies
- Edge runtime built-in support

## Functions

- Read Vietnamese Number
4 changes: 2 additions & 2 deletions deno.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"name": "@hckhanh/vn-number",
"version": "1.1.4",
"version": "1.1.5",
"exports": "./src/index.ts",
"exclude": [
".github/",
"tests/",
"src/**/*.test.ts",
".git*",
".prettier*",
".*ignore",
Expand Down
11 changes: 4 additions & 7 deletions src/read/index.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
import NumberReader from './NumberReader.ts'

/**
* This is a helper that convert a number to a string like the way a real Vietnamese. It comes with features:
*
* - Zero dependencies
* - Edge runtime built-in support
* - Unlimited value (use {@link string} for number bigger than {@link bigint})
* This is a helper that convert a number to a string like the way a real Vietnamese.
* It can be used with unlimited value (use {@link string} for number bigger than {@link bigint})
*
* @example
* ```ts
Expand All @@ -15,8 +12,8 @@ import NumberReader from './NumberReader.ts'
* // output: mười chín triệu chín trăm chín mươi nghìn
* ```
*
* @param number the number to read. It can be string or number type
* @return the Vietnamese number in string.
* @param number The number to read. It can be string, number or bigint value
* @return The Vietnamese number in string.
*/
export function readVnNumber(number: string | number | bigint): string {
return NumberReader.read(number)
Expand Down

0 comments on commit 657b163

Please sign in to comment.