effect-io-ai

Package: effect
Module: FileSystem

FileSystem.KiB

Creates a Size representing kilobytes (1024 bytes).

Details

Converts a number of kilobytes to the equivalent size in bytes. Uses binary kilobytes (1024 bytes) rather than decimal (1000 bytes).

Example (Creating kibibyte sizes)

import { Effect, FileSystem } from "effect"

const program = Effect.gen(function*() {
  const fs = yield* FileSystem.FileSystem

  // Create a 64 KiB buffer size for streaming
  const bufferSize = FileSystem.KiB(64)

  const stream = fs.stream("large-file.txt", {
    chunkSize: bufferSize
  })

  // Truncate file to 100 KiB
  yield* fs.truncate("data.txt", FileSystem.KiB(100))
})

Signature

declare const KiB: (n: number) => Size

Source

Since v4.0.0