Class ByteSize

A CASC byte size (CASC.md §6.9) -- 512MiB, 10GB, !bytes("1.5GiB"). Mirrors the Elixir implementation's {:bytes, count}, with the count held as a bigint so that every literal the spec allows (up to PiB/ PB, with any numeral) is represented exactly.

The closest native JS fit is a plain number: toNumber() (exact up to Number.MAX_SAFE_INTEGER, about 8 PiB) and ByteSize.fromNumber().

Index

Constructors

Properties

Methods

[INSPECT] equals toJSON toNumber toString fromNumber parse

Constructors

constructor

new ByteSize(bytes: bigint): ByteSize
Parameters
- bytes: bigint
Returns ByteSize
- Defined in src/values/byte-size.cjs:16

Properties

bytes

bytes: bigint

Methods

[INSPECT]

"[INSPECT]"(): string
Returns string
- Defined in src/values/byte-size.cjs:69

equals

equals(other: unknown): boolean
Parameters
- other: unknown
Returns boolean
- Defined in src/values/byte-size.cjs:54

toJSON

toJSON(): string
Returns string
- Defined in src/values/byte-size.cjs:64

toNumber

toNumber(): number
Returns number
the byte count as a plain number
- Defined in src/values/byte-size.cjs:46

toString

toString(): string
Returns string
the base-unit form, e.g. "536870912B" -- valid CASC if fed back in
- Defined in src/values/byte-size.cjs:59

`Static`fromNumber

fromNumber(bytes: number): ByteSize
Parameters
- bytes: number
  must be a non-negative safe integer
Returns ByteSize
- Defined in src/values/byte-size.cjs:40

`Static`parse

parse(text: string): ByteSize
Parses byte-size literal text ("512MiB"), with the same rules and errors as a bare literal in a CASC file.
Parameters
- text: string
Returns ByteSize
- Defined in src/values/byte-size.cjs:29