ByteSize - API reference

API reference › @evolu/common › Bytes › ByteSize

type ByteSize = ByteSizeLiteral | ByteLength;

Defined in: packages/common/src/Bytes.ts:1914

ByteSizeLiteral or ByteLength.

Convenience input accepting a human-readable ByteSizeLiteral or a validated ByteLength for values that no literal expresses. APIs normalize it with byteSizeToByteLength.

Example

import {
  assertEqual,
  ByteLength,
  byteSizeToByteLength,
  type ByteSize,
} from "@evolu/common";

const literal: ByteSize = "1MiB";
const validated: ByteSize = ByteLength.orThrow(1000000);

assertEqual(byteSizeToByteLength(literal), 1048576);
assertEqual(byteSizeToByteLength(validated), 1000000);