@half0wl/money

中文文档
1.0.2发布于 2022/12/13MITTypeScriptCommonJS零依赖近 30 天下载 6298

一个TypeScript/JavaScript库,使货币价值的工作更加容易和安全.

中文使用文档
文档目录8 节
  1. 安装
  2. 导入
  3. 特征
  4. 概念
  5. 使用量
  6. 发展
  7. 鸣谢
  8. 许可证

钱 特斯

CI NPM Documentation

这个库旨在让TypeScript/JavaScript中的货币值工作更加安全,更容易.

货币价值总是有货币. 它们按货币区分(1个是) 不等于1欧元,每种货币都有不同的属性,影响 如何显示,四舍五入,分析。 得到所有东西可能很困难 如果你是处理钱, 得到它可能很贵 有什么不对劲!

见: http://martinfowler.com/eaaCatalog/money.html (中文(简体) )

安装

# Using npm:
$ npm i @half0wl/money

# Using yarn:
$ yarn add @half0wl/money

导入

// TypeScript
import { Money } from "@half0wl/money"

// JavaScript/CommonJS
'use strict';
const Money = require("@half0wl/money").Money

特征

  • 算术(加,减等)和比较(等分,大/小等)
  • 不可磨灭. 每个操作返回一个新的 Money 对象,属性不可修改
  • 地方意识字符串格式化
  • 轻量级; 无外部依赖性
  • JavaScript 已完全支持. 启用 严格模式 (单位:千美元)'use strict';)是高度推荐的,但是没有它,这将会是好的
  • 完整文档

概念

金钱对象有一个 currency 财务报告和审定财务报表 amount,其中:

  • 货币是一种 ISO-4217 标准 α代码,例如:. USD, (中文(简体) ), JPY, (中文(简体) ), EUR, (中文(简体) ), SGD
  • 数额以货币最低单位表示,例如5.00美元=500美分 { currency: USD, amount: 500 }

使用量

完整的 API 文档 Money 类可用 这里。 。 。 .

import { Money } from "@half0wl/money"

/**
 * Basic operations
 */
const listing = new Money('USD', 19999)                // Default constructor from int
listing.getCurrency()                                  // => USD
listing.getAmount()                                    // => 19999
listing.toLocaleString()                               // => '$199.99'

const shipping = Money.fromFloat('USD', 15.00)         // From float
shipping.getAmount()                                   // => 1500
shipping.toLocaleString()                              // => '$15.00'

const xmasDiscount = Money.fromString('USD', '2000')   // From int-string
xmasDiscount.getAmount()                               // => 2000
xmasDiscount.toLocaleString()                          // => '$20.00'

const promoDiscount = Money.fromString('USD', '10.00') // From float-string
promoDiscount.getAmount()                              // => 1000
promoDiscount.toLocaleString()                         // => '$10.00'

const subtotal = listing
  .add(shipping)
  .subtract(xmasDiscount, promoDiscount)
subtotal.getCurrency()                                 // => 'USD'
subtotal.getAmount()                                   // => 18499
subtotal.toLocaleString()                              // => '$184.99'

/**
 * Other arithmetic operations
 */
subtotal.multiply(2.4).toLocaleString()                // => '$443.98'
subtotal.divide(8).toLocaleString()                    // => $23.12

/**
 * Comparisons
 */
promoDiscount.equals(promoDiscount)                    // => false
promoDiscount.greaterThan(promoDiscount)               // => true
shipping.greaterThanOrEqual(listing)                   // => false
shipping.lessThan(listing)                             // => true

/**
 * Formatting
 */
const tenDollars = new Money('USD', 1000)
// Using default locale (`en-US`):
tenDollars.toLocaleString()                            // => $10.00
// Using different locale:
tenDollars.toLocaleString('fr-CA')                     // => 10,00 $ US
// JSON
tenDollars.toJSON()                                    // => {
                                                       //      currency: 'USD',
                                                       //      amount: 1000
                                                       //    }

/**
 * Immutability
 */
// All operations return a new `Money` object:
const sixEur = new Money('EUR', 600)
const oneEur = new Money('EUR', 100)
sixEur.add(oneEur)       // This returns a new Money object!
sixEur.toLocaleString()  // => '€6.00'
                         // The amount value is *not* updated in-place.

// To get the result of `sixEur.add(oneEur)`:
const result = sixEur.add(oneEur)
result.toLocaleString()  // => '€7.00'

// Properties are *always* read-only:
// TypeScript
const twoEur = new Money('EUR', 200)
twoEur['amount'] = 0 // => error TS2540: Cannot assign to 'amount'
                     //    because it is a read-only property.

// JavaScript (in strict mode)
'use strict';
const threeEur = new Money('EUR', 300)
threeEur['amount'] = 0 // => TypeError: Cannot assign to read only
                       //    property 'amount' of object '#<Money>'

发展

复制并安装依赖性 :

$ git clone https://github.com/half0wl/money.ts.git
$ yarn install

试验位于 /tests运行它们:

$ yarn test

代码文档使用 类型文件。 。 。 . 要生成文件 :

$ yarn gen-docs

鸣谢

许可证

麻省理工学院

版本与发布记录

@half0wl/money 共发布 3 个版本,首次发布于 2022/12/04;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.0.2latest2022/12/133 年前
1.0.12022/12/133 年前
1.0.02022/12/043 年前

关于 @half0wl/money 的常见问题

@half0wl/money 是什么?

一个TypeScript/JavaScript库,使货币价值的工作更加容易和安全.

如何安装 @half0wl/money?

在项目目录运行 npm install @half0wl/money,或使用 pnpm add / yarn add / bun add。

@half0wl/money 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@half0wl/money 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@half0wl/money 可以商用吗?

@half0wl/money 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@half0wl/money 的下载量有多少?

根据 npm 官方下载统计,@half0wl/money 在 2026/10/17 – 2026/11/15 这 30 天内被下载 6,298 次,日均约 210 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@half0wl/money 还在维护吗?

最新版本 1.0.2 发布于 2022/12/13(3 年前);至今共发布 3 个版本,其中过去 12 个月发布了 0 个;首次发布于 2022/12/04。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。