https://github.com/mbanq/ctc
Countries, timezones and currencies (🇪🇺🕐💶)
https://github.com/mbanq/ctc
countries currencies iso nodejs npm npm-package timezones
Last synced: 4 months ago
JSON representation
Countries, timezones and currencies (🇪🇺🕐💶)
- Host: GitHub
- URL: https://github.com/mbanq/ctc
- Owner: Mbanq
- License: mit
- Created: 2018-01-19T13:26:05.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-02-14T04:00:26.000Z (over 6 years ago)
- Last Synced: 2025-05-27T18:46:29.168Z (4 months ago)
- Topics: countries, currencies, iso, nodejs, npm, npm-package, timezones
- Language: JavaScript
- Size: 90.8 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Countries, Timezones and Currencies - `ctc`
[ ](https://app.codeship.com/projects/266650) [](https://badge.fury.io/js/%40mbanq%2Fctc)
Mbanq's library to work with countries, timezones and currencies
## Install
```
npm install --save @mbanq/ctc
```
## Countries
A country object has following attributes:
* **code** - The country code [ISO code](https://es.wikipedia.org/wiki/ISO_3166-1)
* **name** - Name of the country
* **timezones** - An array of the country's timezones
```json
{
"code": "PT",
"name": "Portugal",
"timezones": [
"Europe/Lisbon",
"Atlantic/Madeira",
"Atlantic/Azores"
]
}
```
## Timezones
A timezone object has following attributes:
* **name** - The name of the timezone.
* **utcOffset** - UTC offset in minutes.
* **offsetStr** - UTC offset in hours (human readable string).
* **countries** - An array of country codes in the timezone.
```json
{
"name": "Europe/Andorra",
"utcOffset": 60,
"offsetStr": "+01:00",
"countries": [ "AD" ]
}
```
## Currencies
A currency object has following attributes:
* **symbol** - Symbolic representation of the currency, e.g. 'Skr'
* **name** - Name of the currency e.g. 'Swedish Krona'
* **symbol_native** - Currenncy's native symbol, e.g. 'kr'
* **decimal_digits** - number of decimal digits, e.g. 2
* **rounding** - currency rounding
* **code** - ISO 4217 currency code, e.g. 'SEK'
* **name_plural** - Currency's plural form, e.g. 'Swedish kronor'
```
{
"symbol": "Skr",
"name": "Swedish Krona",
"symbol_native": "kr",
"decimal_digits": 2,
"rounding": 0,
"code": "SEK",
"name_plural": "Swedish kronor"
}
```
## API
```js
const ctc = require('@mbanq/ctc')
```
`ctc` exposes 3 functions:
* `ctc.countries()` => `Array`
* `ctc.timezones()` => `Array`
* `ctc.search()` => `Array`
### Countries
`countries()` function accepts a country name as a parameter, e.g.
`ctc.countries('Portugal')`
```json
[
{
"code": "PT",
"name": "Portugal",
"timezones": [
"Europe/Lisbon",
"Atlantic/Madeira",
"Atlantic/Azores"
]
}
]
```
`countries()` function always returns an `Array`
### Timezones
`timezones()` function accepts a country name as a parameter, e.g.
`ctc.timezones('Portugal')`
```json
[
{
"name": "Europe/Lisbon",
"utcOffset": 0,
"offsetStr": "+00:00",
"countries": [ "PT" ]
},
{
"name": "Atlantic/Madeira",
"utcOffset": 0,
"offsetStr": "+00:00",
"countries": [ "PT" ]
},
{
"name": "Atlantic/Azores",
"utcOffset": -60,
"offsetStr": "-01:00",
"countries": [ "PT" ]
}
]
```
If you don't provide a country name to the `timezones()` function - the result
will contain all the timezones
`timezones()` function always returns an `Array`
### Currencies
`currencies()` function accepts an `Array` of currency codes, e.g.
`ctc.currencies(['HTG','USD'])`
```json
[
{
"symbol": "HTG",
"name": "Haitian gourde",
"symbol_native": "G",
"decimal_digits": 2,
"rounding": 0,
"code": "HTG",
"name_plural": "Haitian gourdes"
},
{
"symbol": "$",
"name": "US Dollar",
"symbol_native": "$",
"decimal_digits": 2,
"rounding": 0,
"code": "USD",
"name_plural": "US dollars"
}
]
```
### Search
`search()` functions accepts a `String` as a parameter and attempts to find
countries that have the provided parameter either in the `name` of the country
or in the country `code`, e.g. `ctc.search('neth')` would produce following
result:
```json
[
{
"code": "BQ",
"name": "Caribbean Netherlands",
"timezones": [ "America/Curacao" ]
},
{
"code": "NL",
"name": "Netherlands",
"timezones": [ "Europe/Amsterdam" ]
}
]
```
Search is not case sensitive, we `toLowerCase()` everything