openstreetmap-date-format

Format openstreetmap dates (like start_date) in a localized string.

Examples:
``js
osmDateFormat.locale('en')
console.log(osmDateFormat('1940s'))
// 'the 1940s'

console.log(osmDateFormat('2018-10..2018-12-24'))
// 'between October 2018 and December 24, 2018'

osmDateFormat.locale('de')
console.log(osmDateFormat('2018-10..2018-12-24'))
// 'zwischen Oktober 2018 und 24. Dezember 2018'
`

Available locales:
* English (en)
* Deutsch / German (de)
* Français / French (fr) (thanks to james2432)

If you want to contribute another language, please check the howto.

Installation


`sh
npm install --save openstreetmap-date-format
`

API

$3

Convert a date string (as found in a osm tage like 'start_date') to a localized string.

Available options:
* format: choose an alternative format. Currently available: 'long' (default), 'short'

Example:
`js
console.log(osmDateFormat('C19'))
// '19th century'
console.log(osmDateFormat('1980..~1990'))
// 'between 1980 and c. 1990'
console.log(osmDateFormat('1901-02-03'))
// 'February 3, 1901'
console.log(osmDateFormat('1901-02-03', { format: 'short' }))
// 'Feb 3, 1901'
`

$3

Either return the currently set locale or set a different locale. When using browserify it will not be possible to change the current locale, see below how to embed locales.

`js
osmDateFormat.locale('en')
console.log(osmDateFormat('1940s'))
// 'the 1940s'

osmDateFormat.locale('de')
console.log(osmDateFormat('1940s'))
// '1940er Jahre'

console.log(osmDateFormat.locale())
// 'de'
`

$3

Return available locales as array.

Example:
`js
console.log(osmDateFormat.locales())
// [ 'en', 'de', 'fr' ]
`

Localization

$3

`js
const osmDateFormat = require('openstreetmap-date-format')

osmDateFormat.locale('en')

console.log(osmDateFormat('2010-10'))
// 'October 2010'
`

$3


It would be easy to bundle all locales using browserify, but this would also
bloat code. I found the following solution by using a global variable with name locale:

Create files for each locale, example 'locale/de.js':
`js
global.locale = {
id: 'de',
moment: require('moment'),
osmDateFormatTemplates: require('openstreetmap-date-format/templates/de')
}
require('moment/locale/de') // don't do this for 'en'
`

Compile distribution files for each locale:
`sh
browserify locale/de.js -o dist/locale-de.js
`

Additionally include locale file in your app:
`html






...


`

Code:
`js
const osmDateFormat = require('openstreetmap-date-format')

console.log(osmDateFormat('2010-10', { format: 'short' }))
// 'Oct 2010'
`

Command line usage


If installed globally (--global), a command line utility openstreetmap-date-format will be installed, which reads values from stdin and prints the formatted result to stdout.

For further options, use openstreetmap-date-format --help.

Example:
`sh
> echo C17 | openstreetmap-date-format
17th century
> echo C17 | openstreetmap-date-format --format short
17c.
> export LANG=de_DE.UTF-8
> echo C17 | openstreetmap-date-format
17. Jahrhundert
``

Further links

$3

* Source code: https://github.com/plepe/openstreetmap-date-format

$3

* https://wiki.openstreetmap.org/wiki/Key:start_date

Related modules

* openstreetmap-date-parser: parse a date string and return a minimum and maximum date.
* openstreetmap-date-query: builds a regexp from a date query, e.g. for usage with Overpass API.