Add option to disable commifying in dn.format function

[DannyDelott]

Thedn.format function currently always commifies numbers by default. It would be beneficial to have an option to turn this behavior off. This would provide greater flexibility in formatting number strings and improve the interoperability between dn.from and dn.format.

import * as dn from "dnum";

let b = dn.from("870983127.93887"); // dn.from() can parse strings, numbers, bigint and more

console.log(
  dn.format(b, 2), // Current behavior: "870,983,127.94"
  dn.format(b, { digits: 2, commify: false }), // Desired behavior: "870983127.94"
);

[bpierre]

Good point, I think it would be nice to have this. I am wondering how to do it, as the name commify implies the presence of commas which is only true with some locales. Such an option would also override others (compact and locale), which is something I try to avoid if possible.

From what I understand, your case is that you need to store the numbers somewhere as a string, but in a way that is a bit more flexible than toJSON() (which requires to use dnum again to display the number).

Since we already have toNumber(), maybe we could add toString()? It would work in a very similar way:

let value = [123456789000000000000000n, 18];

toString(value); // "123456.789"
toString(value, 1); // "123456.8"

What do you think?

[bpierre]

I made a PR with the change: #5

[DannyDelott]

Good point, I think it would be nice to have this. I am wondering how to do it, as the name commify implies the presence of commas which is only true with some locales. Such an option would also override others (compact and locale), which is something I try to avoid if possible.

From what I understand, your case is that you need to store the numbers somewhere as a string, but in a way that is a bit more flexible than toJSON() (which requires to use dnum again to display the number).

Since we already have toNumber(), maybe we could add toString()? It would work in a very similar way:

let value = [123456789000000000000000n, 18];

toString(value); // "123456.789"
toString(value, 1); // "123456.8"

What do you think?

This is perfect, thanks! We're moving away from formatUnits and commify from ethers to a web3-agnostic formatter and this .toString() would give us exactly what we need for a drop-in replacement. 🤘

[bpierre]

Awesome! It’s published: https://github.com/bpierre/dnum/releases/tag/v2.9.0