All files main.js

100% Statements 106/106
100% Branches 25/25
100% Functions 1/1
100% Lines 106/106

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 10712x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 104x 104x 104x 104x 104x 104x 14x 14x 90x 104x 71x 71x 16x 16x 71x 104x 51x 51x 21x 51x 51x 30x 51x 51x 92x 6x 6x 2x 6x 6x 4x 6x 6x 17x 17x 92x 5x 104x 104x 12x 104x 104x 12x 12x 12x 12x 12x  
/**
* @license Apache-2.0
*
* Copyright (c) 2023 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
 
'use strict';
 
// MODULES //
 
var isNumber = require( '@stdlib/assert/is-number' ).isPrimitive;
var isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive;
var isfinite = require( '@stdlib/math/base/assert/is-finite' );
var format = require( '@stdlib/string/format' );
var int2wordsDE = require( './int2words_de.js' );
var int2wordsEN = require( './int2words_en.js' );
var validate = require( './validate.js' );
var decimals = require( './decimals.js' );
 
 
// MAIN //
 
/**
* Converts a number to a word representation.
*
* @param {number} num - number to convert
* @param {Object} [options] - options
* @param {string} [options.lang='en'] - language code
* @throws {TypeError} must provide valid options
* @returns {string} word representation of number
*
* @example
* var out = num2words( 12 );
* // returns 'twelve'
*
* @example
* var out = num2words( 21.8 );
* // returns 'twenty-one point eight'
*
* @example
* var out = num2words( 1234 );
* // returns 'one thousand two hundred thirty-four'
*
* @example
* var out = num2words( 100381 );
* // returns 'one hundred thousand three hundred eighty-one'
*/
function num2words( num, options ) {
	var parts;
	var opts;
	var err;
 
	if ( !isNumber( num ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be a number. Value: `%s`.', num ) );
	}
	opts = {};
	if ( arguments.length > 1 ) {
		err = validate( opts, options );
		if ( err ) {
			throw err;
		}
	}
	if ( isInteger( num ) ) {
		switch ( opts.lang ) {
		case 'de':
			return int2wordsDE( num, '' );
		case 'en':
		default:
			return int2wordsEN( num, '' );
		}
	}
	if ( !isfinite( num ) ) {
		switch ( opts.lang ) {
		case 'de':
			return ( num < 0 ) ? 'minus unendlich' : 'unendlich';
		case 'en':
		default:
			return ( num < 0 ) ? 'negative infinity' : 'infinity';
		}
	}
	parts = num.toString().split( '.' );
	switch ( opts.lang ) {
	case 'de':
		return int2wordsDE( parts[ 0 ], '' ) + ' Komma ' + decimals( parts[ 1 ], int2wordsDE );
	case 'en':
	default:
		return int2wordsEN( parts[ 0 ], '' ) + ' point ' + decimals( parts[ 1 ], int2wordsEN );
	}
}
 
 
// EXPORTS //
 
module.exports = num2words;