File size: 15,919 Bytes
1e92f2d |
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 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 |
import formatCurrency, { getCurrencyObject, createFormatter } from '../src';
import type { CurrencyFormatter } from '../src/types';
describe( 'formatCurrency default export', () => {
test( 'formats a number to localized currency', () => {
const money = formatCurrency( 99.32, 'USD' );
expect( money ).toBe( '$99.32' );
} );
} );
describe( 'getCurrencyObject default export', () => {
test( 'handles negative values', () => {
const money = getCurrencyObject( -1234.56789, 'USD' );
expect( money ).toEqual( {
symbol: '$',
symbolPosition: 'before',
integer: '1,234',
fraction: '.57',
sign: '-',
hasNonZeroFraction: true,
} );
} );
} );
describe( 'formatCurrency', () => {
let formatter: CurrencyFormatter;
const originalFetch = globalThis.fetch;
beforeEach( () => {
globalThis.fetch = originalFetch;
formatter = createFormatter();
} );
test( 'formats a number to localized currency', () => {
const money = formatter.formatCurrency( 99.32, 'USD' );
expect( money ).toBe( '$99.32' );
} );
test( 'adds a localized thousands separator', () => {
const money = formatter.formatCurrency( 9800900.32, 'USD' );
expect( money ).toBe( '$9,800,900.32' );
} );
test( 'handles zero', () => {
const money = formatter.formatCurrency( 0, 'USD' );
expect( money ).toBe( '$0.00' );
const money2 = formatter.formatCurrency( 0, 'USD', { stripZeros: true } );
expect( money2 ).toBe( '$0' );
const money3 = formatter.formatCurrency( 0, 'EUR', { locale: 'en-US' } );
expect( money3 ).toBe( '€0.00' );
const money4 = formatter.formatCurrency( 0, 'EUR', { stripZeros: true } );
expect( money4 ).toBe( '€0' );
} );
test( 'handles negative values', () => {
const money = formatter.formatCurrency( -1234.56789, 'USD' );
expect( money ).toBe( '-$1,234.57' );
} );
test( 'unknown currency codes return default', () => {
const money = formatter.formatCurrency( 9800900.32, '' );
expect( money ).toBe( '$9,800,900.32' );
} );
test( 'unknown locale codes return default', () => {
const money = formatter.formatCurrency( 9800900.32, 'USD', { locale: 'foo-bar' } );
expect( money ).toBe( '$9,800,900.32' );
} );
test( 'formats a number to localized currency for smallest unit', () => {
const money = formatter.formatCurrency( 9932, 'USD', { isSmallestUnit: true } );
expect( money ).toBe( '$99.32' );
} );
test( 'formats a number to localized currency for smallest unit for non-decimal currency', () => {
const money = formatter.formatCurrency( 9932, 'JPY', { isSmallestUnit: true } );
expect( money ).toBe( '¥9,932' );
} );
test( 'formats a rounded number if the number is a float and smallest unit is true', () => {
const money = formatter.formatCurrency( 9932.1, 'USD', { isSmallestUnit: true } );
expect( money ).toBe( '$99.32' );
} );
test( 'returns no trailing zero cents when stripZeros set to true (USD)', () => {
const money = formatter.formatCurrency( 9800900, 'USD', {} );
expect( money ).toBe( '$9,800,900.00' );
// Trailing zero cents should be removed.
const money2 = formatter.formatCurrency( 9800900, 'USD', { stripZeros: true } );
expect( money2 ).toBe( '$9,800,900' );
// It should not strip non-zero cents.
const money3 = formatter.formatCurrency( 9800900.32, 'USD', { stripZeros: true } );
expect( money3 ).toBe( '$9,800,900.32' );
} );
test( 'returns no trailing zero cents when stripZeros set to true (EUR)', () => {
const money = formatter.formatCurrency( 9800900, 'EUR', { locale: 'de-DE' } );
expect( money ).toBe( '9.800.900,00 €' );
// Trailing zero cents should be removed.
const money2 = formatter.formatCurrency( 9800900, 'EUR', {
locale: 'de-DE',
stripZeros: true,
} );
expect( money2 ).toBe( '9.800.900 €' );
// It should not strip non-zero cents.
const money3 = formatter.formatCurrency( 9800900.32, 'EUR', {
locale: 'de-DE',
stripZeros: true,
} );
expect( money3 ).toBe( '9.800.900,32 €' );
} );
test( 'returns a plus sign for positive numbers if signForPositive is true (USD)', () => {
const money = formatter.formatCurrency( 9800900, 'USD', {} );
expect( money ).toBe( '$9,800,900.00' );
const money2 = formatter.formatCurrency( 9800900, 'USD', {
signForPositive: true,
} );
expect( money2 ).toBe( '+$9,800,900.00' );
} );
test( 'returns a negative sign for negative numbers if signForPositive is true (USD)', () => {
const money = formatter.formatCurrency( -9800900, 'USD', {} );
expect( money ).toBe( '-$9,800,900.00' );
const money2 = formatter.formatCurrency( -9800900, 'USD', {
signForPositive: true,
} );
expect( money2 ).toBe( '-$9,800,900.00' );
} );
test( 'returns a plus sign for positive numbers if signForPositive is true (EUR)', () => {
const money = formatter.formatCurrency( 9800900, 'EUR', { locale: 'de-DE' } );
expect( money ).toBe( '9.800.900,00 €' );
const money2 = formatter.formatCurrency( 9800900, 'EUR', {
locale: 'de-DE',
signForPositive: true,
} );
expect( money2 ).toBe( '+9.800.900,00 €' );
} );
test( 'returns a number in latin numbers even for locales which default to other character sets', () => {
const money = formatter.formatCurrency( 9800900, 'INR', { locale: 'mr-IN' } );
expect( money ).toBe( '₹9,800,900.00' );
} );
test( 'sets USD currency symbol to $ if geolocation is US and locale is en', async () => {
globalThis.fetch = jest.fn(
( url: string ) =>
Promise.resolve( {
json: () =>
url.includes( '/geo' )
? Promise.resolve( { country_short: 'US' } )
: Promise.resolve( 'invalid' ),
} ) as any
);
formatter = createFormatter();
await formatter.geolocateCurrencySymbol();
const money = formatter.formatCurrency( 9800900.32, 'USD', { locale: 'en-US' } );
expect( money ).toBe( '$9,800,900.32' );
} );
test( 'sets USD currency symbol to US$ if geolocation is US but locale is not en', async () => {
globalThis.fetch = jest.fn(
( url: string ) =>
Promise.resolve( {
json: () =>
url.includes( '/geo' )
? Promise.resolve( { country_short: 'US' } )
: Promise.resolve( 'invalid' ),
} ) as any
);
formatter = createFormatter();
await formatter.geolocateCurrencySymbol();
const money = formatter.formatCurrency( 9800900.32, 'USD', { locale: 'fr' } );
expect( money ).toBe( '9 800 900,32 $US' );
} );
test( 'sets USD currency symbol to US$ if geolocation is US but locale is an en variant', async () => {
globalThis.fetch = jest.fn(
( url: string ) =>
Promise.resolve( {
json: () =>
url.includes( '/geo' )
? Promise.resolve( { country_short: 'US' } )
: Promise.resolve( 'invalid' ),
} ) as any
);
formatter = createFormatter();
await formatter.geolocateCurrencySymbol();
const money = formatter.formatCurrency( 9800900.32, 'USD', { locale: 'en-CA' } );
expect( money ).toBe( 'US$9,800,900.32' );
} );
test( 'does not change USD currency symbol from $ if geolocation is unknown and locale is en', async () => {
globalThis.fetch = jest.fn(
( url: string ) =>
Promise.resolve( {
json: () =>
url.includes( '/geo' )
? Promise.resolve( { country_short: '' } )
: Promise.resolve( 'invalid' ),
} ) as any
);
formatter = createFormatter();
await formatter.geolocateCurrencySymbol();
const money = formatter.formatCurrency( 9800900.32, 'USD', { locale: 'en' } );
expect( money ).toBe( '$9,800,900.32' );
} );
test( 'sets USD currency symbol to US$ if geolocation is not US and locale is en', async () => {
globalThis.fetch = jest.fn(
( url: string ) =>
Promise.resolve( {
json: () =>
url.includes( '/geo' )
? Promise.resolve( { country_short: 'CA' } )
: Promise.resolve( 'invalid' ),
} ) as any
);
formatter = createFormatter();
await formatter.geolocateCurrencySymbol();
const money = formatter.formatCurrency( 9800900.32, 'USD', { locale: 'en' } );
expect( money ).toBe( 'US$9,800,900.32' );
} );
describe( 'specific currencies', () => {
test( 'USD', () => {
const money = formatter.formatCurrency( 9800900.32, 'USD' );
expect( money ).toBe( '$9,800,900.32' );
} );
test( 'USD in Canadian English', () => {
const money = formatter.formatCurrency( 9800900.32, 'USD', { locale: 'en-CA' } );
expect( money ).toBe( 'US$9,800,900.32' );
} );
test( 'AUD', () => {
const money = formatter.formatCurrency( 9800900.32, 'AUD' );
expect( money ).toBe( 'A$9,800,900.32' );
} );
test( 'CAD in Canadian English', () => {
const money = formatter.formatCurrency( 9800900.32, 'CAD', { locale: 'en-CA' } );
expect( money ).toBe( 'C$9,800,900.32' );
} );
test( 'CAD in US English', () => {
const money = formatter.formatCurrency( 9800900.32, 'CAD', { locale: 'en-US' } );
expect( money ).toBe( 'C$9,800,900.32' );
} );
test( 'CAD in Canadian French', () => {
const money = formatter.formatCurrency( 9800900.32, 'CAD', { locale: 'fr-CA' } );
expect( money ).toBe( '9 800 900,32 C$' );
} );
test( 'EUR in EN locale', () => {
const money = formatter.formatCurrency( 9800900.32, 'EUR', { locale: 'en-US' } );
expect( money ).toBe( '€9,800,900.32' );
} );
test( 'EUR in DE locale set by setDefaultLocale', () => {
formatter.setDefaultLocale( 'de-DE' );
const money = formatter.formatCurrency( 9800900.32, 'EUR' );
expect( money ).toBe( '9.800.900,32 €' );
} );
test( 'EUR in DE locale', () => {
const money = formatter.formatCurrency( 9800900.32, 'EUR', { locale: 'de-DE' } );
expect( money ).toBe( '9.800.900,32 €' );
} );
test( 'EUR in FR locale', () => {
const money = formatter.formatCurrency( 9800900.32, 'EUR', { locale: 'fr-FR' } );
expect( money ).toBe( '9 800 900,32 €' );
} );
test( 'GBP', () => {
const money = formatter.formatCurrency( 9800900.32, 'GBP' );
expect( money ).toBe( '£9,800,900.32' );
} );
test( 'JPY', () => {
const money = formatter.formatCurrency( 9800900.32, 'JPY' );
expect( money ).toBe( '¥9,800,900' );
} );
test( 'BRL in EN locale', () => {
const money = formatter.formatCurrency( 9800900.32, 'BRL', { locale: 'en-US' } );
expect( money ).toBe( 'R$9,800,900.32' );
} );
test( 'BRL in PT locale', () => {
const money = formatter.formatCurrency( 9800900.32, 'BRL', { locale: 'pt-BR' } );
expect( money ).toBe( 'R$ 9.800.900,32' );
} );
test( 'IDR', () => {
const money = formatter.formatCurrency( 107280000, 'IDR', {
locale: 'in-ID',
isSmallestUnit: true,
} );
expect( money ).toBe( 'Rp 1.072.800,00' );
} );
} );
} );
describe( 'getCurrencyObject()', () => {
let formatter: CurrencyFormatter;
beforeEach( () => {
formatter = createFormatter();
} );
test( 'handles zero', () => {
const money = formatter.getCurrencyObject( 0, 'USD' );
expect( money ).toEqual( {
symbol: '$',
symbolPosition: 'before',
integer: '0',
fraction: '.00',
sign: '',
hasNonZeroFraction: false,
} );
} );
test( 'handles negative values', () => {
const money = formatter.getCurrencyObject( -1234.56789, 'USD' );
expect( money ).toEqual( {
symbol: '$',
symbolPosition: 'before',
integer: '1,234',
fraction: '.57',
sign: '-',
hasNonZeroFraction: true,
} );
} );
test( 'handles values that round up', () => {
const money = formatter.getCurrencyObject( 9.99876, 'USD' );
expect( money ).toEqual( {
symbol: '$',
symbolPosition: 'before',
integer: '10',
fraction: '.00',
sign: '',
hasNonZeroFraction: false,
} );
} );
test( 'handles values that round down', () => {
const money = formatter.getCurrencyObject( 9.99432, 'USD' );
expect( money ).toEqual( {
symbol: '$',
symbolPosition: 'before',
integer: '9',
fraction: '.99',
sign: '',
hasNonZeroFraction: true,
} );
} );
test( 'handles a number in the smallest unit', () => {
const money = formatter.getCurrencyObject( 9932, 'USD', { isSmallestUnit: true } );
expect( money ).toEqual( {
symbol: '$',
symbolPosition: 'before',
integer: '99',
fraction: '.32',
sign: '',
hasNonZeroFraction: true,
} );
} );
test( 'handles a number in the smallest unit for non-decimal currency', () => {
const money = formatter.getCurrencyObject( 9932, 'JPY', { isSmallestUnit: true } );
expect( money ).toEqual( {
symbol: '¥',
symbolPosition: 'before',
integer: '9,932',
fraction: '',
sign: '',
hasNonZeroFraction: false,
} );
} );
test( 'handles the number as rounded if the number is a float and smallest unit is set', () => {
const money = formatter.getCurrencyObject( 9932.1, 'USD', { isSmallestUnit: true } );
expect( money ).toEqual( {
symbol: '$',
symbolPosition: 'before',
integer: '99',
fraction: '.32',
sign: '',
hasNonZeroFraction: true,
} );
} );
describe( 'specific currencies', () => {
test( 'USD', () => {
const money = formatter.getCurrencyObject( 9800900.32, 'USD' );
expect( money ).toEqual( {
symbol: '$',
symbolPosition: 'before',
integer: '9,800,900',
fraction: '.32',
sign: '',
hasNonZeroFraction: true,
} );
} );
test( 'USD with signForPositive set', () => {
const money = formatter.getCurrencyObject( 9800900.32, 'USD', { signForPositive: true } );
expect( money ).toEqual( {
symbol: '$',
symbolPosition: 'before',
integer: '9,800,900',
fraction: '.32',
sign: '+',
hasNonZeroFraction: true,
} );
} );
test( 'USD with signForPositive set and negative number', () => {
const money = formatter.getCurrencyObject( -9800900.32, 'USD', { signForPositive: true } );
expect( money ).toEqual( {
symbol: '$',
symbolPosition: 'before',
integer: '9,800,900',
fraction: '.32',
sign: '-',
hasNonZeroFraction: true,
} );
} );
test( 'USD in Canadian English', () => {
const money = formatter.getCurrencyObject( 9800900.32, 'USD', { locale: 'en-CA' } );
expect( money ).toEqual( {
symbol: 'US$',
symbolPosition: 'before',
integer: '9,800,900',
fraction: '.32',
sign: '',
hasNonZeroFraction: true,
} );
} );
test( 'AUD', () => {
const money = formatter.getCurrencyObject( 9800900.32, 'AUD' );
expect( money ).toEqual( {
symbol: 'A$',
symbolPosition: 'before',
integer: '9,800,900',
fraction: '.32',
sign: '',
hasNonZeroFraction: true,
} );
} );
test( 'CAD', () => {
const money = formatter.getCurrencyObject( 9800900.32, 'CAD', { locale: 'en-US' } );
expect( money ).toEqual( {
symbol: 'C$',
symbolPosition: 'before',
integer: '9,800,900',
fraction: '.32',
sign: '',
hasNonZeroFraction: true,
} );
} );
test( 'EUR', () => {
const money = formatter.getCurrencyObject( 9800900.32, 'EUR', { locale: 'de-DE' } );
expect( money ).toEqual( {
symbol: '€',
symbolPosition: 'after',
integer: '9.800.900',
fraction: ',32',
sign: '',
hasNonZeroFraction: true,
} );
} );
test( 'GBP', () => {
const money = formatter.getCurrencyObject( 9800900.32, 'GBP' );
expect( money ).toEqual( {
symbol: '£',
symbolPosition: 'before',
integer: '9,800,900',
fraction: '.32',
sign: '',
hasNonZeroFraction: true,
} );
} );
test( 'JPY', () => {
const money = formatter.getCurrencyObject( 9800900.32, 'JPY' );
expect( money ).toEqual( {
symbol: '¥',
symbolPosition: 'before',
integer: '9,800,900',
fraction: '',
sign: '',
hasNonZeroFraction: false,
} );
} );
test( 'BRL', () => {
const money = formatter.getCurrencyObject( 9800900.32, 'BRL', { locale: 'pt-BR' } );
expect( money ).toEqual( {
symbol: 'R$',
symbolPosition: 'before',
integer: '9.800.900',
fraction: ',32',
sign: '',
hasNonZeroFraction: true,
} );
} );
} );
} );
|