Skip to content

fix(formatUnit): allow to change base on formatUnit #1405

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 26, 2023
Merged

fix(formatUnit): allow to change base on formatUnit #1405

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
39d7507
fix(formatUnit): allow to change base on formatUnit
vincentaudebert Jul 26, 2023
0c369f5
fix: adds comments for default value
vincentaudebert Jul 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/young-shirts-unite.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@scaleway/use-i18n': minor
---

Allow to change base on formatUnit calculations
114 changes: 114 additions & 0 deletions packages/use-i18n/src/__tests__/__snapshots__/formatUnit.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,120 @@ exports[`formatUnit should work with { unit: 'zettabyte' } 1`] = `"12,56 Zo"`;

exports[`formatUnit should work with { unit: 'zettabyte-humanized' } 1`] = `"0 Zo"`;

exports[`formatUnit should work with base { base: 2, unit: 'bit' } 1`] = `"4,294,967,296 b"`;

exports[`formatUnit should work with base { base: 2, unit: 'bit-humanized' } 1`] = `"4,294,967,296 b"`;

exports[`formatUnit should work with base { base: 2, unit: 'bit-per-second' } 1`] = `"4,294,967,296 bps"`;

exports[`formatUnit should work with base { base: 2, unit: 'bit-per-second-humanized' } 1`] = `"4,294,967,296 bps"`;

exports[`formatUnit should work with base { base: 2, unit: 'bits-humanized' } 1`] = `"4 Gb"`;

exports[`formatUnit should work with base { base: 2, unit: 'bits-per-second-humanized' } 1`] = `"4 Gbps"`;

exports[`formatUnit should work with base { base: 2, unit: 'byte' } 1`] = `"4,294,967,296 B"`;

exports[`formatUnit should work with base { base: 2, unit: 'byte-humanized' } 1`] = `"4,294,967,296 B"`;

exports[`formatUnit should work with base { base: 2, unit: 'bytes-humanized' } 1`] = `"4 GB"`;

exports[`formatUnit should work with base { base: 2, unit: 'exabit' } 1`] = `"4,294,967,296 Eb"`;

exports[`formatUnit should work with base { base: 2, unit: 'exabit-humanized' } 1`] = `"0 Eb"`;

exports[`formatUnit should work with base { base: 2, unit: 'exabit-per-second' } 1`] = `"4,294,967,296 Ebps"`;

exports[`formatUnit should work with base { base: 2, unit: 'exabit-per-second-humanized' } 1`] = `"0 Ebps"`;

exports[`formatUnit should work with base { base: 2, unit: 'exabyte' } 1`] = `"4,294,967,296 EB"`;

exports[`formatUnit should work with base { base: 2, unit: 'exabyte-humanized' } 1`] = `"0 EB"`;

exports[`formatUnit should work with base { base: 2, unit: 'gigabit' } 1`] = `"4,294,967,296 Gb"`;

exports[`formatUnit should work with base { base: 2, unit: 'gigabit-humanized' } 1`] = `"4 Gb"`;

exports[`formatUnit should work with base { base: 2, unit: 'gigabit-per-second' } 1`] = `"4,294,967,296 Gbps"`;

exports[`formatUnit should work with base { base: 2, unit: 'gigabit-per-second-humanized' } 1`] = `"4 Gbps"`;

exports[`formatUnit should work with base { base: 2, unit: 'gigabyte' } 1`] = `"4,294,967,296 GB"`;

exports[`formatUnit should work with base { base: 2, unit: 'gigabyte-humanized' } 1`] = `"4 GB"`;

exports[`formatUnit should work with base { base: 2, unit: 'kilobit' } 1`] = `"4,294,967,296 Kb"`;

exports[`formatUnit should work with base { base: 2, unit: 'kilobit-humanized' } 1`] = `"4,194,304 Kb"`;

exports[`formatUnit should work with base { base: 2, unit: 'kilobit-per-second' } 1`] = `"4,294,967,296 Kbps"`;

exports[`formatUnit should work with base { base: 2, unit: 'kilobit-per-second-humanized' } 1`] = `"4,194,304 Kbps"`;

exports[`formatUnit should work with base { base: 2, unit: 'kilobyte' } 1`] = `"4,294,967,296 KB"`;

exports[`formatUnit should work with base { base: 2, unit: 'kilobyte-humanized' } 1`] = `"4,194,304 KB"`;

exports[`formatUnit should work with base { base: 2, unit: 'megabit' } 1`] = `"4,294,967,296 Mb"`;

exports[`formatUnit should work with base { base: 2, unit: 'megabit-humanized' } 1`] = `"4,096 Mb"`;

exports[`formatUnit should work with base { base: 2, unit: 'megabit-per-second' } 1`] = `"4,294,967,296 Mbps"`;

exports[`formatUnit should work with base { base: 2, unit: 'megabit-per-second-humanized' } 1`] = `"4,096 Mbps"`;

exports[`formatUnit should work with base { base: 2, unit: 'megabyte' } 1`] = `"4,294,967,296 MB"`;

exports[`formatUnit should work with base { base: 2, unit: 'megabyte-humanized' } 1`] = `"4,096 MB"`;

exports[`formatUnit should work with base { base: 2, unit: 'petabit' } 1`] = `"4,294,967,296 Pb"`;

exports[`formatUnit should work with base { base: 2, unit: 'petabit-humanized' } 1`] = `"0 Pb"`;

exports[`formatUnit should work with base { base: 2, unit: 'petabit-per-second' } 1`] = `"4,294,967,296 Pbps"`;

exports[`formatUnit should work with base { base: 2, unit: 'petabit-per-second-humanized' } 1`] = `"0 Pbps"`;

exports[`formatUnit should work with base { base: 2, unit: 'petabyte' } 1`] = `"4,294,967,296 PB"`;

exports[`formatUnit should work with base { base: 2, unit: 'petabyte-humanized' } 1`] = `"0 PB"`;

exports[`formatUnit should work with base { base: 2, unit: 'terabit' } 1`] = `"4,294,967,296 Tb"`;

exports[`formatUnit should work with base { base: 2, unit: 'terabit-humanized' } 1`] = `"0 Tb"`;

exports[`formatUnit should work with base { base: 2, unit: 'terabit-per-second' } 1`] = `"4,294,967,296 Tbps"`;

exports[`formatUnit should work with base { base: 2, unit: 'terabit-per-second-humanized' } 1`] = `"0 Tbps"`;

exports[`formatUnit should work with base { base: 2, unit: 'terabyte' } 1`] = `"4,294,967,296 TB"`;

exports[`formatUnit should work with base { base: 2, unit: 'terabyte-humanized' } 1`] = `"0 TB"`;

exports[`formatUnit should work with base { base: 2, unit: 'yottabit' } 1`] = `"4,294,967,296 Yb"`;

exports[`formatUnit should work with base { base: 2, unit: 'yottabit-humanized' } 1`] = `"0 Yb"`;

exports[`formatUnit should work with base { base: 2, unit: 'yottabit-per-second' } 1`] = `"4,294,967,296 Ybps"`;

exports[`formatUnit should work with base { base: 2, unit: 'yottabit-per-second-humanized' } 1`] = `"0 Ybps"`;

exports[`formatUnit should work with base { base: 2, unit: 'yottabyte' } 1`] = `"4,294,967,296 YB"`;

exports[`formatUnit should work with base { base: 2, unit: 'yottabyte-humanized' } 1`] = `"0 YB"`;

exports[`formatUnit should work with base { base: 2, unit: 'zettabit' } 1`] = `"4,294,967,296 Zb"`;

exports[`formatUnit should work with base { base: 2, unit: 'zettabit-humanized' } 1`] = `"0 Zb"`;

exports[`formatUnit should work with base { base: 2, unit: 'zettabit-per-second' } 1`] = `"4,294,967,296 Zbps"`;

exports[`formatUnit should work with base { base: 2, unit: 'zettabit-per-second-humanized' } 1`] = `"0 Zbps"`;

exports[`formatUnit should work with base { base: 2, unit: 'zettabyte' } 1`] = `"4,294,967,296 ZB"`;

exports[`formatUnit should work with base { base: 2, unit: 'zettabyte-humanized' } 1`] = `"0 ZB"`;

exports[`formatUnit should work with locale en and { unit: 'bit' } 1`] = `"12.56 b"`;

exports[`formatUnit should work with locale en and { unit: 'bit-humanized' } 1`] = `"13 b"`;
Expand Down
6 changes: 6 additions & 0 deletions packages/use-i18n/src/__tests__/formatUnit.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,12 @@ const tests: TestType[] = [
'fr',
12,
]),
...SUPPORTED_UNITS.map<TestType>(unit => [
'should work with base',
{ base: 2, unit },
'en',
4294967296, // 4 GB
]),
]

describe('formatUnit', () => {
Expand Down
15 changes: 13 additions & 2 deletions packages/use-i18n/src/formatUnit.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,10 +137,12 @@ const format =
maximumFractionDigits,
minimumFractionDigits,
short = true,
base = 10,
}: {
maximumFractionDigits?: number
minimumFractionDigits?: number
short?: boolean
base?: number
},
): string => {
let computedExponent = exponent
Expand All @@ -149,7 +151,7 @@ const format =
if (humanize) {
if (computedExponent) {
const value = filesize(amount, {
base: 10,
base,
exponent: exponents.findIndex(
exp => exp.name === (computedExponent as Exponent).name,
),
Expand All @@ -159,7 +161,7 @@ const format =
computedValue = value.value
} else {
const value = filesize(amount, {
base: 10,
base,
output: 'object',
round: maximumFractionDigits,
}) as unknown as { value: number; symbol: string; exponent: number }
Expand Down Expand Up @@ -247,7 +249,16 @@ export const supportedUnits: Partial<

export type FormatUnitOptions = {
unit: SupportedUnits
/**
default: true
*/
short?: boolean
maximumFractionDigits?: number
minimumFractionDigits?: number
/**
default: 10
*/
base?: number
}

const formatUnit = (
Expand Down