13ab9007f6
* Add workflow_call event * Add tests-daily-run.yml * Remove workflow version * Update input value * Remove secrets from caller workflow * Rename job * Check context * Check context * Check workflow_call inputs * Override github.event_name with inputs.trigger * Fix input name * Add config for daily e2e tests with Gutenberg * Update env commands for Gutenberg run * Add disableHpos env variable in ci-utils * Revert the trigger to push * Revert the env variable setting in ci-jobs * Revert the env variable setting in ci-jobs * Rebuild utils * Update test env start command * Define the Gutenberg Playwright project * Use path relative to workspace root * Update events for test projects * Update events for test projects * Add changelogs * Remove the e2e tests with Gutenberg tests from daily runs * Set the schedule and workflow_dispatch triggers * Add --project default flag to only run the default tests in CI * Renamed snapshots to match the new Playwright project name |
||
---|---|---|
.. | ||
changelog | ||
src | ||
.eslintrc.js | ||
.npmrc | ||
CHANGELOG.md | ||
PREVIOUS_CHANGELOG.md | ||
README.md | ||
babel.config.js | ||
composer.json | ||
composer.lock | ||
jest.config.json | ||
package.json | ||
tsconfig-cjs.json | ||
tsconfig.json |
README.md
Currency
A collection of utilities to display and work with currency values.
Installation
Install the module
pnpm install @woocommerce/currency --save
This package assumes that your code will run in an ES2015+ environment. If you're using an environment that has limited or no support for ES2015+ such as lower versions of IE then using core-js or @babel/polyfill will add support for these methods. Learn more about it in Babel docs.
Usage
import CurrencyFactory from '@woocommerce/currency';
const storeCurrency = CurrencyFactory(); // pass store settings into constructor.
// Formats money with a given currency symbol. Uses site's currency settings for formatting,
// from the settings api. Defaults to symbol=`$`, precision=2, decimalSeparator=`.`, thousandSeparator=`,`
const total = storeCurrency.formatAmount( 20.923 ); // '$20.92'
// Get the rounded decimal value of a number at the precision used for the current currency,
// from the settings api. Defaults to 2.
const total = storeCurrency.formatDecimal( '6.2892' ); // 6.29
// Get the string representation of a floating point number to the precision used by the current
// currency. This is different from `formatAmount` by not returning the currency symbol.
const total = storeCurrency.formatDecimalString( 1088.478 ); // '1088.48'