Socket
Socket
Sign inDemoInstall

@brixtol/currency-symbol-placements

Package Overview
Dependencies
0
Maintainers
1
Versions
7
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @brixtol/currency-symbol-placements

Mappings for Currency Symbol placements using currency.js patterns


Version published
Weekly downloads
1
decreased by-66.67%
Maintainers
1
Install size
20.7 kB
Created
Weekly downloads
 

Changelog

Source

1.2.0 - 21/10/2021

  • Changed method getCurrencyPlacement to getPlacement
  • Updated rollup-config

Readme

Source

@brixtol/currency-placements

Currency Symbol placements for currency.js. Mappings use (ISO 4217) 3 letter currency codes and return the format pattern (!#) used by currency.js where ! is the currency symbol and # the amount.

This package is used by the Brixtol Textiles internal API when dealing with currency conversion and presentation locales pertaining to i18n logics and has been open sourced from our pnpm monorepo workspace.

Why?

We found the the vast majority of U.S commerce SaaS services were constantly getting currency symbol placements wrong. We use currency.js to convert currencies in our mithril.js applications and this package provides us with a wrapper for getting placements correct.

Install

pnpm

pnpm i @brixtol/currency-symbol-placements

npm

npm install @brixtol/currency-symbol-placements

Yarn

yarn add @brixtol/currency-symbol-placements

Usage

Pass in a currency code that is lowercase, uppercase or a mixture of both and the pattern replacement string is returned.

import currency from 'currency.js';
import { getPlacement } from '@brixtol/currency-symbols-placements';

// Currency code SEK (Swedish Krona) - Kr
const SEK = getPlacement('SEK'); // # !

// Currency code EUR (Euros) - €
const EUR = getPlacement('eur'); // !#

// Using with currency.js
currency('510.00', {
  separator: '.',
  decimal: ',',
  fromCents: true,
  pattern: SEK // returning "# !" > "510.00 kr"
}).format();

// ....

Locale related mappings helpers:

Country code to currency code mappings:

Contributing

Contributions are welcome! Currency symbol placements are a real mixed bag and generally do not adhere to official specifications on the matter. If the mapping placements are not accurate, please submit a PR with some foundations.

See the package.json for scripts and make sure you are using pnpm, because pnpm is dope and does dope shit.

License

Licensed under MIT


We open source!

Keywords

FAQs

Last updated on 24 Oct 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc