VirtualFileSystem

Core and matricestypeOpenCV 5.0.0

import type { VirtualFileSystem } from '@banou/opencv-wasm'

Files used by native codecs, model readers and algorithms belong to this instance. Paths refer to its virtual filesystem, including in Node.

export type VirtualFileSystem = {
  writeFile(path: string, data: string | ArrayBufferView, options?: {
    flags?: string,
    encoding?: 'utf8' | 'binary',
  }): void,
  readFile(path: string, options?: {
    encoding?: 'binary',
    flags?: string,
  }): Uint8Array<ArrayBuffer>,
  readFile(path: string, options: {
    encoding: 'utf8',
    flags?: string,
  }): string,
  mkdir(path: string, mode?: number): unknown,
  mkdirTree(path: string, mode?: number): void,
  rmdir(path: string): void,
  readdir(path: string): string[],
  unlink(path: string): void,
  rename(from: string, to: string): void,
  stat(path: string): FileStat,
  lstat(path: string): FileStat,
  cwd(): string,
  chdir(path: string): void,
  chmod(path: string, mode: number): void,
  isFile(mode: number): boolean,
  isDir(mode: number): boolean,
}

These signatures describe this package. Upstream documentation can mention optional backends that are absent from this build. Check runtime compatibility before choosing a backend or file format.