检查数字货币库

版权所有 2021-2026 检查 Digit, LLC

Check Digit货币库是Check Digit服务在特定日期/时间处理货币类型,格式化以及国家/货币关系的官方认可方法. 特征 :

• 从2018年开始的某个特定日期/时间及以后,任何更早的货币和国家查询功能都会出错.
• 数量、货币、 ISO 3166 国家代码( 数字, alpha2, alpha3) 和 ISO 4217 货币代码( 名称、 字母、 数字) 类型
• check Digit- Standard 货币格式化 Money 对象,有多种选项
• 将字符串分析为检查数字标准货币对象
• 测试以确保遵守基于数字的Intl。 数字格式货币执行
• 测试,以确保基本JS引擎在货币方面的正确性
• 多地( 所有现代浏览器和节点 24+ 包含全 伊斯兰法院联盟(中文(简体) )
• 使用内置JS引擎 Intl 执行,无依赖

安装

npm install @checkdigit/currency

然后:

import * as currency from '@checkdigit/currency';

类型和接口

货币库的四个核心类型是:

• 量,是以比和或字符串形式(或-0)为整数.
• 货币,即与货币Alphabetic Code(例如“USD”)的货币结合的金额
• 国家,是含有一国ISO 3166信息和货币的对象
• 货币,是含有货币ISO 4217信息的对象

国家和货币代码有定义的文字类型:

• 货币法
• 货币编码
• 货币Name
• 阿尔法2国
• 阿尔法3国
• 国名

export interface Money {
  amount: string; // integer amount in minor units, e.g. '12345' for $123.45
  currency: CurrencyAlphabeticCode;
}

export interface Country {
  // ISO 3166 country display name, alpha2/3 and numeric codes
  name: string;
  alpha2: CountryAlpha2; // 'US' | 'NZ' ...
  alpha3: CountryAlpha3; // 'USA' | 'NZL' ...
  numeric: CountryNumeric; // '840' | '554' ...

  // ISO 4217 currencies
  currencyCodes: CurrencyAlphabeticCode[];
}

export interface Currency {
  name: CurrencyName; // 'US Dollar' | 'New Zealand Dollar' ...
  alphabeticCode: CurrencyAlphabeticCode; // 'USD' | 'NZD' ...
  numericCode: CurrencyNumericCode; // '840' | '554' ...
  minorUnits?: number;
  isFund?: true;
}

职能

格式化

• format({ amount, currency }: Money, options?: CurrencyFormatOptions, locales?: string | string[]): string

分析

• parse(money: string, currency: CurrencyAlphabeticCode, locales?: string | string[]) => Money;

货币

• allCurrencies(): Currency[]
• findCurrency(search: string): Currency
• getCurrency(code: CurrencyAlphabeticCode | CurrencyNumericCode): Currency
• getMinorUnitDigits(currency: CurrencyAlphabeticCode)
• getSymbol(currency: CurrencyAlphabeticCode, locales?: string | string[]): string

国家

• allCountries(): Country[]
• getCountry(code: CountryAlpha2 | CountryAlpha3 | CountryNumeric): Country
• getCountriesForCurrency(code: CurrencyAlphabeticCode): CountryAlpha3[]

用法实例

format

currency('2023-11-02T15:35:47.191Z').format({
  amount: '123456789012345678901234567890',
  currency: 'USD',
});
// $1,234,567,890,123,456,789,012,345,678.90

currency('2023-11-02T15:35:47.191Z').format({
  amount: '123456',
  currency: 'USD',
});
// $1234.56

currency('2023-11-02T15:35:47.191Z').format(
  { amount: '123456', currency: 'USD' },
  {
    useGrouping: false,
    useCurrency: false,
  },
);
// 1234.56

currency('2023-11-02T15:35:47.191Z').format(
  { amount: '123456', currency: 'USD' },
  {
    useGrouping: false,
    useCurrency: false,
    useDecimal: false,
  },
);
// 123456

currency('2023-11-02T15:35:47.191Z').format({ amount: '-0', currency: 'USD' });
// -$0.00

currency('2023-11-02T15:35:47.191Z').format(
  { amount: '123456789', currency: 'USD' },
  {
    currencyDisplay: 'code',
  },
  'de-DE',
);
// 1.234.567,89 USD

currency('2023-11-02T15:35:47.191Z').format(
  { amount: '123456', currency: 'USD' },
  {
    useDecimal: false,
    useGrouping: false,
    useCurrency: false,
  },
  'as-IN',
);
// ১২৩৪৫৬

parse

currency('2023-11-02T15:35:47.191Z').parse('.1', 'USD');
// { amount: '10', currency: 'USD' }

currency('2023-11-02T15:35:47.191Z').parse('1', 'USD');
// { amount: '100', currency: 'USD' }

currency('2023-11-02T15:35:47.191Z').parse('$1.23', 'USD');
// { amount: '123', currency: 'USD' }

currency('2023-11-02T15:35:47.191Z').parse('123.456,78', 'EUR', 'de-DE');
// { amount: '12345678', currency: 'EUR' }

currency('2023-11-02T15:35:47.191Z').parse('10€', 'EUR');
// { amount: '1000', currency: 'EUR' }

currency('2023-11-02T15:35:47.191Z').parse('10', 'JPY');
// { amount: '10', currency: 'JPY' }

getSymbol

currency('2023-11-02T15:35:47.191Z').getSymbol('USD');
// $

currency('2023-11-02T15:35:47.191Z').getSymbol('NZD');
// NZ$

currency('2023-11-02T15:35:47.191Z').getSymbol('NZD', 'en-NZ');
// $

getMinorUnitDigits

currency('2023-11-02T15:35:47.191Z').getMinorUnitDigits('USD');
// 2

currency('2023-11-02T15:35:47.191Z').getMinorUnitDigits('JPY');
// 0

findCurrency

currency('2023-11-02T15:35:47.191Z').findCurrency('us dollar');
// {
//   name: 'US Dollar',
//   alphabeticCode: 'USD',
//   numericCode: '840',
//   minorUnits: 2
// }

currency('2023-11-02T15:35:47.191Z').findCurrency(554);
// {
//   name: 'New Zealand Dollar',
//   alphabeticCode: 'NZD',
//   numericCode: '554',
//   minorUnits: 2
// }

getCurrency

currency('2023-11-02T15:35:47.191Z').getCurrency('840');
// {
//   name: 'US Dollar',
//   alphabeticCode: 'USD',
//   numericCode: '840',
//   minorUnits: 2
// }

currency('2023-11-02T15:35:47.191Z').getCurrency('NZD');
// {
//   name: 'New Zealand Dollar',
//   alphabeticCode: 'NZD',
//   numericCode: '554',
//   minorUnits: 2
// }

getCountry

currency('2023-11-02T15:35:47.191Z').getCountry('USA');
// {
//   name: 'US',
//   alpha2: 'US',
//   alpha3: 'USA',
//   numeric: '840',
//   currencyCodes: [ 'USD' ]
// }

getCountriesForCurrency

currency('2023-11-02T15:35:47.191Z').getCountriesForCurrency('NZD');
// [ 'COK', 'NIU', 'NZL', 'PCN', 'TKL' ]

许可证

麻省理工学院