Skip to content

Update README.md #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TylerVigario wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ import Mass from 'mass.js';
let value = Mass.parse('5 lbs 8 oz'); // Parse string for mass
value += 5.5; // Add 5.5 pounds
Mass.format(value); // Format total: "11 lb"
Mass.format(value, { written: true }); // Written format: "eleven pounds"
```

## Units
Expand Down Expand Up @@ -55,19 +54,12 @@ Format number as string.

- **unit:** `(number|string)` Base unit value or string for lookup (default: 1).

- **written:** `(Object|string|boolean)` [n2words](https://github.com/forzagreen/n2words) options or language identifier (as string), otherwise boolean (default: false).

Returns `value` formatted as `string`, or if unit lookup fails, `undefined`.

**Examples:**

```javascript
Mass.format(11);

Mass.format(176, {
unit: 'oz',
written: true
});
```

------------
Expand Down