npmpackage.info

@shopify/condense-number

Locale-aware number condensing

1.0.1

MIT

TypeScript

Installations

npm install @shopify/condense-number

Pull Requests

Open

3

Total

82

Closed

28

Merged

51

Issues

Open

3

Total

25

Closed

22

Releases

Unable to fetch releases

Developer

Shopify

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

16.13.2

NPM Version

6.14.17 Statistics

41 Stars

111 Commits

9 Forks

378 Watching

9 Branches

6,926 Contributors

Updated on 06 Mar 2024

Languages

TypeScript (99.71%)

JavaScript (0.29%)

Total Downloads

Cumulative downloads

Total Downloads

7,812,841

Last day

-49.9%

2,355

Compared to previous day

Last week

-37.2%

14,781

Compared to previous week

Last month

-25%

141,268

Compared to previous month

Last year

-16.8%

1,962,013

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

jest eslint ts-jest prettier in-publish typescript @types/jest microbundle eslint-plugin-shopify eslint-plugin-prettier

Versions

condense-number

Locale-aware number and currency condensing.

condense-number uses Unicode Common Locle Data Repository (CLDR) and Intl.js formatting patterns to inform locale-aware number and currency condensing. What does number condensing mean? In English 50,000 condenses to 50K, but it's 50 mil in Portuguese and 5 万 in Japanese.

The following locales are now available in condense-number:

Danish (da)
German (de)
Greek (el)
English (en)
Spanish (es)
Finnish (fi)
French (fr)
Hindi (hi)
Italian (it)
Japanese (ja)
Korean (ko)
Malay (ms)
Norwegian (nb-NO)
Dutch (nl)
Polish (pl)
Brazilian Portuguese (pt-BR)
Romanian (ro)
Russian (ru)
Swedish (sv)
Thai (th)
Turkish (tr)
Chinese (Simplified) (zh-CN)
Chinese (Traditional) (zh-TW)

How to use

Install @shopify/condense-number in your project:

1yarn add @shopify/condense-number

Both condenseNumber and condenseCurrency are exported as named exports and can be imported individually.

condenseNumber

Provide a number and locale, get the condensed value. If a condensed value isn't applicable, condenseNumber returns the number with formatting, if appropriate.

Example:

condenseNumber(1000, 'en') = '1K'

Optionally, specify maximum precision within an options object to override the default decimal precision of 0. Precision will not be applied if the decimal value is 0.

condenseNumber(1500, 'en', {maxPrecision: 1}) = '1.5K'

condenseCurrency

Provide a number, locale and currency code, get the value with the currency provided, formatted according to the locale's standards. If a condensing isn't applicable, condenseCurrency returns the currency with formatting, but without condensing.

condenseCurrency(15000, 'en', 'usd') = '$15K';

Optionally, specify maximum precision within an options object to override the default decimal precision of 0. Precision will not be applied if the decimal value is 0.

condenseCurrency(1500, 'en', 'gbp', {maxPrecision: 1}) = '£1.5K'

When a currency symbol is not found, the capitalized currency code will be used instead. For example:

condenseCurrency(150000, 'en', 'abc') = 'ABC150K'

Rounding

By default, condensed numbers round down. For example:

condenseNumber(1500, 'en') = '1K'

However, if you want to round to the closest integer or always round up to the next integer, you can specify that in the options object, by using 'auto' or 'up':

condenseNumber(1200, 'en', {roundingRule: 'auto'}) = '1K'

condenseCurrency(1100, 'en', 'gbp', {roundingRule: 'up'})

= '£2K'

Rounding can be used with maxPrecision.

condenseNumber(1089, 'en', {roundingRule: 'auto', maxPrecision: 1});

= 1.1K

How it works

If you're curious, have a look at the CLDR data used under the hood. The logic we apply to the JSON is informed by documentation (here and here) from Unicode. We use Intl.js, which also relies on CLDR data, to inform our currency codes and number patterns.

Development instructions

Install the specified Node version: nvm install
Install dependencies: npx yarn install

You can now run:

Test: npx yarn run test
Code formatting: npx yarn run format
Building: npx yarn run build

No vulnerabilities found.

10

License

Determines if the project has defined a license.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

9

Security-Policy

Determines if the project has published a security policy.

8

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3.8

/10

Last Scanned on 2024-07-01

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to @shopify/condense-number

condense-newlines

0.2.1

Replace extraneous newlines with a single newline, or pass a specified number of newlines to use.

trim-repeated

2.0.0

Trim a consecutively repeated substring: foo--bar---baz → foo-bar-baz

@shopify/function-enhancers

3.1.0

A set of helpers to enhance functions

condense-whitespace

3.0.0

Remove leading, trailing, and repeated whitespace from a string