Type Alias IFileSize

IFileSize: { "[TO_BYTES]"(): number }

File size contract enabling interoperability with external file size libraries. Provides a standard way to convert any file size representation to bytes.

Allows this library to work with external size libraries without direct dependencies:

  • Byte wrapper objects
  • Kilobyte/Megabyte/Gigabyte representations
  • Custom file size classes

Implementers need only provide one method: convert their file size format to bytes.

Usage:

  1. Implement IFileSize on your file size class by computing the TO_BYTES method
  2. Pass instances to any daiso-core function accepting IFileSize
  3. The library will call the method to get byte values for size calculations

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

Type declaration

  • [TO_BYTES]:function
    • "[TO_BYTES]"(): number

    • Converts this file size to total bytes. Used by the library for all size-based calculations and comparisons.

      Returns number

      Total file size in bytes (must be >= 0)

Settings

Member Visibility