Class FileSize

The FileSize class is used for representing file size. FileSize class cannot be negative, if you pass negative number it will be converted to 0.

IMPORT_PATH: "@daiso-tech/core/file-size"

Implements

Methods

[TO_BYTES]

"[TO_BYTES]"(): number
Returns number
Implementation of IFileSize.[TO_BYTES]
- Defined in src/file-size/implementations/file-size.ts:69

equals

equals(value: IFileSize): boolean
Checks if this value equals the given value. Implementation defines what "equal" means for this type.
Parameters
- value: IFileSize
  The value to compare against
Returns boolean
True if values are equal, false otherwise
Implementation of IComparable.equals
- Defined in src/file-size/implementations/file-size.ts:73

gt

gt(value: IFileSize): boolean
Checks if this value is greater than the given value.
Parameters
- value: IFileSize
  The value to compare against
Returns boolean
True if this > value, false otherwise
Implementation of IComparable.gt
- Defined in src/file-size/implementations/file-size.ts:77

gte

gte(value: IFileSize): boolean
Checks if this value is greater than or equal to the given value.
Parameters
- value: IFileSize
  The value to compare against
Returns boolean
True if this >= value, false otherwise
Implementation of IComparable.gte
- Defined in src/file-size/implementations/file-size.ts:81

lt

lt(value: IFileSize): boolean
Checks if this value is less than the given value.
Parameters
- value: IFileSize
  The value to compare against
Returns boolean
True if this < value, false otherwise
Implementation of IComparable.lt
- Defined in src/file-size/implementations/file-size.ts:85

lte

lte(value: IFileSize): boolean
Checks if this value is less than or equal to the given value.
Parameters
- value: IFileSize
  The value to compare against
Returns boolean
True if this <= value, false otherwise
Implementation of IComparable.lte
- Defined in src/file-size/implementations/file-size.ts:89

serialize

serialize(): SerializedFileSize
Serializes this instance to a versioned format. Instance method that converts the current state to a storable/transportable form. Must include a version field for deserialization to know how to reconstruct.

Returns SerializedFileSize
Serialized representation with version field
Implementation of ISerializable.serialize
- Defined in src/file-size/implementations/file-size.ts:93

toBytes

toBytes(): number
Returns number
- Defined in src/file-size/implementations/file-size.ts:100

toGigaBytes

toGigaBytes(): number
Returns number
- Defined in src/file-size/implementations/file-size.ts:112

toKiloBytes

toKiloBytes(): number
Returns number
- Defined in src/file-size/implementations/file-size.ts:104

toMegaBytes

toMegaBytes(): number
Returns number
- Defined in src/file-size/implementations/file-size.ts:108

toPetaBytes

toPetaBytes(): number
Returns number
- Defined in src/file-size/implementations/file-size.ts:120

toTeraBytes

toTeraBytes(): number
Returns number
- Defined in src/file-size/implementations/file-size.ts:116

`Static`deserialize

deserialize(serializedValue: SerializedFileSize): FileSize
Parameters
- serializedValue: SerializedFileSize
Returns FileSize
- Defined in src/file-size/implementations/file-size.ts:37

`Static`fromBytes

fromBytes(bytes: number): FileSize
Parameters
- bytes: number
Returns FileSize
- Defined in src/file-size/implementations/file-size.ts:41

`Static`fromGigaBytes

fromGigaBytes(gigaBytes: number): FileSize
Parameters
- gigaBytes: number
Returns FileSize
- Defined in src/file-size/implementations/file-size.ts:53

`Static`fromKiloBytes

fromKiloBytes(kiloBytes: number): FileSize
Parameters
- kiloBytes: number
Returns FileSize
- Defined in src/file-size/implementations/file-size.ts:45

`Static`fromMegaBytes

fromMegaBytes(megaBytes: number): FileSize
Parameters
- megaBytes: number
Returns FileSize
- Defined in src/file-size/implementations/file-size.ts:49

`Static`fromPetaBytes

fromPetaBytes(petaBytes: number): FileSize
Parameters
- petaBytes: number
Returns FileSize
- Defined in src/file-size/implementations/file-size.ts:61

`Static`fromTeraBytes

fromTeraBytes(teraBytes: number): FileSize
Parameters
- teraBytes: number
Returns FileSize
- Defined in src/file-size/implementations/file-size.ts:57