Class MmapFile

Readonlybase

Readonlypath

Readonlysize

advise

• advise(offset: number, length: number, advice: number): number

  madvise a page-aligned sub-range (offset + length should be page multiples). e.g. advise(off, len, MADV_DONTNEED) to release clean expert pages back to the OS; they re-fault from the file on next read.

  Parameters

  • offset: number
  • length: number
  • advice: number

  Returns number

pointer

• pointer(offset: number): number

  Raw pointer to byte offset (for FFI consumers like mlx).

  Parameters

  • offset: number

  Returns number

unmap

• unmap(): void

  Returns void

view

• view(offset: number, length: number): Uint8Array

  JS view of a range. Only for small ranges (headers, spot checks); the view aliases the mapping — do not retain past munmap.

  Parameters

  • offset: number
  • length: number

  Returns Uint8Array

Staticopen

• open(path: string, mode?: "ro" | "cow"): MmapFile

  Open read-only (MAP_SHARED) or copy-on-write (MAP_PRIVATE + PROT_WRITE — writes go to private pages, never the file; used for KV-cache reloads where mlx may donate buffers).

  Parameters

  • path: string
  • mode: "ro" | "cow" = "ro"

  Returns MmapFile