Skip to content

Add JS syntax to readme examples #13

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
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add JS syntax to readme examples #13

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
31 changes: 19 additions & 12 deletions Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,28 +25,35 @@ Highly configurable formatter that expects a valid number in 'computer' format a
- `noUnits` boolean: if true will override and leave out prefix and suffix; default= false
- `noSeparator` - boolean: if true will override both integer and decimals separator and leave them out

## Usage

## Import
```javascript
// CommonJS
var formatNumber = require('format-number');

// ES6
import formatNumber from 'format-number';
```
var format=require('format-number');
var formattedNumber = format({prefix: '£', suffix: '/item'})(68932, {noSeparator: true});

## Usage

```javascript
var formattedNumber = formatNumber({prefix: '£', suffix: '/item'})(68932, {noSeparator: true});
>> '£68932/item'
```

or

```
var format=require('format-number');
var myFormat = format({prefix: '£', suffix: '/item'});
```javascript
var myFormat = formatNumber({prefix: '£', suffix: '/item'});
var formattedNumber = myFormat(68932, {noSeparator: true});
>> '£68932/item'
```

will both set formattedNumber to '£68932/item'

The override options can be ommitted:

```javascript
var formattedNumber = formatNumber({prefix: '£', suffix: '/item'})(68932);
>> '£68,932/item'
```
var format=require('format-number');
var formattedNumber = format({prefix: '£', suffix: '/item'})(68932);
```

returns '£68,932/item'