Skip to content

formatBytes — @gj-kit/format

A public function from @gj-kit/format. The signature below is taken directly from the 0.1.1 release declaration.

import { formatBytes } from '@gj-kit/format';
/**
* Byte quantity with an explicit unit system. `system: 'decimal'` divides by
* 1000 and labels KB/MB; `system: 'binary'` divides by 1024 and labels
* KiB/MiB — the label always tells the truth about the divisor.
*/
declare function formatBytes<TFallback = string>(value: number | null | undefined, options: FormatBytesOptions<TFallback>): string | TFallback;

This declaration is the source of truth for parameters, optionality, generics, return values, and public union/type contracts. Check the package golden path and this subpath’s import conditions for required environment, permission, and error boundaries before calling it.

  • Package: @gj-kit/format
  • Version: 0.1.1
  • Public entry: .
  • Source: GitHub