atma-formatter v0.8.15

Formatter Library (NodeJS and Browser)

Features:

• Date Formatter
• Number Formatter
• String Formatter (format, align, pluralize)
• Static Methods
• Languages and Cultures
• MaskJS util support

Usage

NodeJS

var Formatter = require('atma-formatter');

Browser

• examples

window.Formatter

Date Formatter

Standalone NodeJS example:

var format = require('atma-formatter');
var str = format(new Date, "#d MMM, yyyy (hh:mm)");
//>  1 January, 2014 (09:55)

Mask example: mask

div > 'Today - ~[format: today, "#d MMM, yyyy (hh:mm)"]'

javascript model

{ today: new Date }

Output

<div>Today - 1 January, 2014 (09:55)</div>

Javascript example:

var str = mask._.format(new Date, "#d MMM, yyyy (hh:mm)");
//>  1 January, 2014 (09:55)

Number Formatter

Pattern: e.g. ,0.0

Samples:

Standalone NodeJS example:

var format = require('atma-formatter');
var str = format(4500.3851, ",0.00");
//>  4,500.39

Mask example

div > 'Sum - ~[format: sum, ",0.00"]'

Javascript model

{ sum: 4500.3851 }

Output

<div>Sum - 4,500.39</div>

Javascript example

var str = mask._.format(4500.3851, ",0.00");
//>  4,500.39

String Formatter

{ accessor[,alignment][:pattern][;switch] }

• accessor: index or dot-notated property

  	```javascript
  	/* index */
  	format('Hello {0} - {1} {0}', 'World', 'my')
  	//> 'Hello World, my World'
  
  	/* property */
  	format('Hello {name} - {stats.qux}', {
  		name: 'Bar',
  		stats: {
  			qux: 20
  		}
  	});
  	//> 'Hello Bar - 20'
  	```

• alignment: minimum chars count with right/left alignment

  	```javascript
  	format('x{0,10}x', 'Q');
  	//> 'x         Qx'
  	format('x{0,-10}x', 'Q');
  	//> 'xQ         x'
  
  	```

• pattern: Date Number format patterns. Refer to Date Formatter and Number Formatter

  	```javascript
  	format('Year: {date:yyyy}', { date: new Date(2015, 0, 1)});
  	//> Year: 2015
  	```

• switch/pluralization: pattern:string;otherPattern:string; ... Choose interpolated string according to arguments value. Each string can contain nested interpolations. i18n benefits of this feature

  	- Number patterns:
  		- Strict and Ending patterns: `12`, `*12`
  		- Ranges: `12-16`, `*12-16`
  		- Groups: `0,1,2`
  		- Any: `*`
  	
  	```javascript
  	format('{num; 0:Foo; 1,2:Baz {name}}', {
  		num: 2,
  		name: 'Qux'
  	})
  	//> 'Baz Qux'
  
  	// i18n, e.g. russian has 3 plural forms. 'N day(s)' sample
  	format('{days} {days; *0,*11-14,*5-9: дней; *1: день; *2-4:дня }', {
  		days: 21
  	})
  	//> '21 день'
  
  	// It is also possible to move pluralization pattern to the cultureInfo.
  	// then it would be
  	format('{days} {days; день, дня, дней }', {
  		days: 21
  	})
  	//> '21 день'
  	```

Standalone NodeJS example:

var format = require('atma-formatter');
var str = format(
	"Name: {0}; Born: {1:dd MMM yyyy}; Salary: ${2:,0.00}",
	'John',
	new Date(1975, 0, 1),
	17000
);
//>  Name: John; Born: 01 January 1975; Salary: $17,000.00

Mask example

div > '~[format: "Name: {0}; Born: {1:dd MMM yyyy}; Salary: ${2:,0.00}", user.name, user.birth, user.salary]'

Javascript model

{ user: { name: 'John', birth: new Date(1975, 0, 1), salary: 17000 } }

Output

<div>Name: John; Born: 01 January 1975; Salary: $17,000.00</div>

Javascript example

var str = mask._.format("{0:,000}", 5.35);
//>  005

Static methods

The format method takes the formatter by the input value. You can use formatters directly. Formatters will also try to convert the input value to the desired type. For instance, when a string is passed to formatDate then we try to convert it to the Date instance.

var Formatter = require('atma-formatter');
Formatter.formatNumber(value, pattern, cultureInfo?);
Formatter.formatString(value, pattern, cultureInfo?);
Formatter.formatDate(value, pattern, cultureInfo?);

Internationalization

There are already EN and DE support.

Add culture support sample:

var formatter = require('atma-formatter');
formatter.Lang.$register('ru', {
	MONTH: ['Январь',...],
	MONTH_SHORT: ['Ян.',...],
	DAY: ['Воскресенье',...],
	DAY_SHORT: ['Bc',...],

	NUMBER: {
		// 1 000 000,00
		Delimiter: ' ',
		Point: ',',
		Default: string|number
		// When number, then for NaN input the default value will be formatted
		// When string, then it will be returned on NaN input
	}
});
formatter.Lang.$use('ru');

Build, Test

• Build

  	```bash
  	$ npm install atma -g
  	$ atma
  	```

• Test

  	```bash
  	$ atma test
  	```

(c) MIT - Atma.js Project