@stdlib/nlp-ordinalize v0.2.1

ordinalize

Convert an integer to an ordinal string (e.g., 1st, 2nd, etc.).

Installation

npm install @stdlib/nlp-ordinalize

Usage

var ordinalize = require( '@stdlib/nlp-ordinalize' );

ordinalize( value[, options] )

Converts an integer to an ordinal string (e.g., 1st, 2nd, etc.).

var out = ordinalize( '22' );
// returns '22nd'

out = ordinalize( 13 );
// returns '13th'

The function accepts the following options:

• lang: string indicating the language. Default: 'en'.
• suffixOnly: boolean indicating whether to return only the ordinal suffix. Default: false.
• gender: string indicating whether to use the masculine or feminine grammatical form. Default: 'masculine'.

By default, the function returns an ordinal string. To return only an ordinal suffix, set the suffixOnly option.

var out = ordinalize( '22', {
    'suffixOnly': true
});
// returns 'nd'

By default, the function returns an ordinal string in English. To return an ordinal string for a different language, set the lang option.

var out = ordinalize( '22', {
    'lang': 'fr'
});
// returns '22e'

By default, if a language differentiates between masculine and feminine grammatical forms, the functions returns an ordinal string in the masculine form. To return an ordinal string in the feminine form, set the gender option.

var opts = {
    'lang': 'es',
    'gender': 'masculine'
};
var out = ordinalize( 7, opts );
// returns '7º'

opts.gender = 'feminine';
out = ordinalize( 7, opts );
// returns '7ª'

Notes

• The following languages are supported:

  • en: English.
  • es: Spanish.
  • fin: Finnish.
  • fr: French.
  • de: Dutch.
  • it: Italian.
  • pt: Portuguese.
  • swe: Swedish.

Examples

var ordinalize = require( '@stdlib/nlp-ordinalize' );

var out = ordinalize( '1' );
// returns '1st'

out = ordinalize( 2 );
// returns '2nd'

out = ordinalize( '3', {
    'suffixOnly': true
});
// returns 'rd'

out = ordinalize( '3', {
    'lang': 'de'
});
// returns '3.'

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.