# icu-loader

> A package to load full ICU data in Node.js environment with JavaScript Intl API

Latest version **4.0.0** (published 2018-01-18) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install icu-loader
pnpm add icu-loader
yarn add icu-loader
bun add icu-loader
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 4.0.0 |
| Published | 2018-01-18 |
| First published | 2016-12-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| Author | Masoud Ghorbani |
| Maintainers | msudgh |
| Keywords | node.js, icu, full-icu, i18n, intl, internationalization |

## Links

- npm: https://www.npmjs.com/package/icu-loader
- Repository: https://github.com/msudgh/icu-loader
- Homepage: https://github.com/msudgh/icu-loader#readme
- Issues: https://github.com/msudgh/icu-loader/issues
- npm.io page: https://npm.io/package/icu-loader

## Dependencies (4)

- [full-icu](https://npm.io/package/full-icu.md) ^1.2.0
- [lodash.isdate](https://npm.io/package/lodash.isdate.md) ^4.0.1
- [lodash.isnumber](https://npm.io/package/lodash.isnumber.md) ^3.0.3
- [lodash.isstring](https://npm.io/package/lodash.isstring.md) ^4.0.1

## Alternatives

- [messageformat](https://npm.io/package/messageformat.md) — 329.7K weekly downloads
- [@mintlify/scraping](https://npm.io/package/@mintlify/scraping.md) — 294.8K weekly downloads
- [@mintlify/previewing](https://npm.io/package/@mintlify/previewing.md) — 209.5K weekly downloads
- [@mintlify/prebuild](https://npm.io/package/@mintlify/prebuild.md) — 209.5K weekly downloads
- [@mintlify/link-rot](https://npm.io/package/@mintlify/link-rot.md) — 206.3K weekly downloads

## Recent versions

- 4.0.0 (latest) — 2018-01-18
- 3.0.1 — 2017-07-30
- 3.0.0 — 2017-07-30
- 2.0.3 — 2017-01-04
- 2.0.2 — 2017-01-02
- 2.0.1 — 2016-12-30
- 2.0.0 — 2016-12-30
- 1.0.7 — 2016-12-24
- 1.0.6 — 2016-12-21
- 1.0.5 — 2016-12-20
- 1.0.4 — 2016-12-20
- 1.0.3 — 2016-12-19
- 1.0.2 — 2016-12-18
- 1.0.1 — 2016-12-18
- 1.0.0 — 2016-12-18

## README

# ICU Loader · [![Travis](https://img.shields.io/travis/msudgh/icu-loader.svg?style=flat-square)](https://travis-ci.org/msudgh/icu-loader) [![npm](https://img.shields.io/npm/v/icu-loader.svg?style=flat-square)](https://www.npmjs.com/package/icu-loader) [![npm](https://img.shields.io/npm/l/icu-loader.svg?style=flat-square)](https://www.npmjs.com/package/icu-loader)

A package to load full ICU data in Node.js environment with JavaScript Intl API

# But Why?
To use [**`JavaScript Intl API`**][8], Node.js needs to run with **`--icu-data-dir`** option that provides us to have Intl API in our Node environment but because of the structure of the Node.js we're not able to use this option directly as requiring it in our scripts. through **`child_process`** module, this feature will be possible.


# Example
```js
import { IDate } from 'icu-loader'

let date = new IDate(new Date(2016, 9, 16))
date.toLocaleString('en-US', { year: 'numeric', month: 'long', day: 'numeric' })
  .then(result => console.log(result)) // October 16, 2016
```

# Table of Contents
  * [Requirements](#requirements)
  * [Usage](#usage)
  * [Contributing](#contributing)
  * [License](#license)
  
# Requirements
ICU Loader requires the following to run:
  * [Node.js][1] 6.2.0+
  * [full-icu][2] package (it'll be install as dependencies)

# Usage
ICU Loader is easiest to use when installing with [npm][4]:
```bash
npm install icu-loader --save
```

Then you can load the module into your codes by the ES module or CommonJS:
```js
// ES module
import {IDate, IString, INumber} from 'icu-loader';

// Or import specific class
import IString from 'icu-loader';

// CommonJS
let date = require('icu-loader').IDate;
let string = require('icu-loader').IString;
let number = require('icu-loader').INumber;
```
According to JavaScript Intl API, the module has the following objects ([IDate](#date), [IString](#string), [INumber](#number)) and various methods.
> The star (*) sign means the argument is optional.

### IDate
#### Syntax
```js
new IDate()
new IDate(dateObj)
```

| Argument Name        | Type                      | Description                                       |
| -------------------- | ------------------------- | ------------------------------------------------- |
| dateObj              | Date, String              | the reference date object                         |

#### Methods
All arguments of the methods of Date object are same, the following methods:
  * **toLocaleString(dateObj, locale, [options])**
  * **toLocaleDateString(dateObj, locale, [options])**
  * **toLocaleTimeString(dateObj, locale, [options])**

#### Arguments
| Argument Name        | Type                      | Description                                       |
| -------------------- | ------------------------- | ------------------------------------------------- |
| locale               | String                    | the locale string that date will be displayed in  |
| options *            | Object                    | [documents][5]                                    |

#### Example
```js
import IDate from 'icu-loader'

let date = new IDate(new Date(2016, 9, 16))

// US English uses month-day-year order and 12-hour time with AM/PM
date.toLocaleString('en-US')
  .then(result => console.log(result)); // "9/16/2016, 0:00:00 PM"

// request a weekday along with a long date
var options = { weekday: 'long', year: 'numeric', month: 'long', day: 'numeric' };
date.toLocaleString('de-DE', options)
  .then(result => cosnole.log(result)); // "Sonntag, 16. Oktober 2016"

// Arabic in most Arabic speaking countries uses real Arabic digits
date.toLocaleDateString('ar-EG')
  .then(result => cosnole.log(result)); // "۲۰۱۶/۹/۱۶"

// Korean uses year-month-day order and 12-hour time with AM/PM
date.toLocaleTimeString(new Date(2016, 9, 16, 14, 15, 05), 'ko-KR')
  .then(result => cosnole.log(result)); // "오후 2:15:05"

// sometimes even the US needs 24-hour time
date.toLocaleTimeString(new Date(), 'en-US', { hour12: false }))
  .then(result => cosnole.log(result)); // "19:00:00"
```

### IString
#### Syntax
```js
new IDate(string)
```

| Argument Name        | Type                      | Description                                       |
| -------------------- | ------------------------- | ------------------------------------------------- |
| string               | String                    | the reference string object                       |

#### Methods
The IString class just has one method to comparing two string in same or different locales, the following method:
  * **localeCampare(referenceStr, compareString, locale, [options])**

#### Arguments
| Argument Name        | Type           | Description                                        |
| -------------------- | -------------- | -------------------------------------------------- |
| compareString        | String         | the comparable string                              |
| locale               | String         | the locale string that string will be compared in  |
| options *            | Object         | [documents][6]                                     |

#### Example
```js
import IString from 'icu-loader'

// The letter  "a" is before "c" yielding a negative value
new IString('a').localeCompare('c')
  .then(result => cosnole.log(result)); // -2 or -1 (or some other negative valu e)

// Using locales
new IString('ä').localeCompare('z', 'sv')
  .then(result => cosnole.log(result)); // a positive value: in Swedish, ä sorts after z

// in German, ä has a as the base letter
new IString('ä').localeCompare('a', 'de', { sensitivity: 'base' }))
  .then(result => cosnole.log(result)); // 0
```

### Number
#### Syntax
```js
new INumber(number)
```
| Argument Name        | Type                      | Description                                         |
| -------------------- | ------------------------- | --------------------------------------------------- |
| number               | Number                    | the reference number object                         |

#### Methods
this class has one method to represent a number in different locales, the following method:
  * **toLocaleString(numberObj, locale, [options])**

#### Arguments
| Argument Name        | Type                      | Description                                         |
| -------------------- | ------------------------- | --------------------------------------------------- |
| locale               | String                    | the locale string that number will be displayed in  |
| options *            | Object                    | [documents][5]                                      |

#### Example
```js
import INumber from 'icu-loader';

// English locale
new INumber(3500).toLocaleString()
  .then(result => cosnole.log(result)); // Displays "3,500" if in U.S.

// German uses comma as decimal separator and period for thousands
new INumber(123456.789).toLocaleString('de-DE')
  .then(result => cosnole.log(result)); // 123.456,789

// Using options
new INumber(30000000000).toLocaleString('fa-IR', { style: 'currency', currency: 'IRR' })
  .then(result => cosnole.log(result)); // ‎ریال۳۰٬۰۰۰٬۰۰۰٬۰۰۰
```

# Contributing
To contribute to ICU Loader, clone this repo locally and commit your code on the **`development`** branch. Please run the linter before opening a pull request:
```bash
## To run tests
npm run test

## To find out the errors
npm run lint

## To fix automatically the errors
npm run lint:fix
```

# License
ICU Loader is licensed under the [MIT][7] license, also [full-icu][2] package is part of [ICU][3].

Copyright © 2018, Masoud Ghorbani

  [1]: https://github.com/nodejs/node/blob/master/doc/changelogs/CHANGELOG_V6.md#6.2.0
  [2]: https://www.npmjs.com/package/full-icu/
  [3]: http://site.icu-project.org/
  [4]: https://www.npmjs.com/
  [5]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toLocaleString#Parameters
  [6]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/localeCampare#Parameters
  [7]: https://msudgh.mit-license.org/
  [8]: https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Intl

---
_Source: https://npm.io/package/icu-loader · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._