Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/segment-boneyard/locale-string
Convert locale strings to english names and back
https://github.com/segment-boneyard/locale-string
Last synced: about 5 hours ago
JSON representation
Convert locale strings to english names and back
- Host: GitHub
- URL: https://github.com/segment-boneyard/locale-string
- Owner: segment-boneyard
- Created: 2014-07-30T23:01:25.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2014-11-25T01:42:48.000Z (almost 10 years ago)
- Last Synced: 2024-11-11T20:33:08.124Z (4 days ago)
- Language: JavaScript
- Size: 202 KB
- Stars: 12
- Watchers: 41
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: Readme.md
- Changelog: History.md
Awesome Lists containing this project
README
# locale-string [](https://circleci.com/gh/segmentio/locale-string/tree/master)
Convert locale strings to english names and back. Used with pairs of [ISO 639-1 language codes][language] and [ISO 3166-1-alpha-2][country] country codes.
[language]: http://en.wikipedia.org/wiki/ISO_639-1
[country]: http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
## Install
```sh
$ npm install locale-string
```
## Usage
```js
var locale = require('locale-string');
// convert from english words
locale('English', 'United States'); // 'en-US'
// or parse locale strings
locale.parse('en-CA'); // { language: 'English', country: 'Canada' }
```
## API
### locale-string(language, country)
Returns a locale string of the two letter language and country codes given their proper english names.
```js
locale('English', 'United States'); // 'en-US'
```
### .parse(locale)
Returns an object containing the parsed language and country
```js
locale.parse('en-CA'); // { language: 'English', country: 'Canada' }
```
## License
(The MIT License)
Copyright (c) 2014 Segment.io <[email protected]>
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.