Class CopyOnWriteFSInternal

constructor

• new CopyOnWriteFS(
      readable: FileSystem,
      writable: FileSystem,
      journal?: Journal,
  ): CopyOnWriteFS

  Parameters

  • readable: FileSystem

    The file system that initially populates this file system.
  • writable: FileSystem

    The file system to write modified files to.
  • journal: Journal = ...

    The journal to use for persisting deletions

  Returns CopyOnWriteFS

Readonlyjournal

Readonlyreadable

Readonlywritable

createFile

• createFile(
      path: string,
      flag: string,
      mode: number,
      options: CreationOptions,
  ): Promise<File<FileSystem>>

  Create the file at path with the given options. Then, open it with flag.

  Parameters

  • path: string
  • flag: string
  • mode: number
  • options: CreationOptions

  Returns Promise<File<FileSystem>>

createFileSync

• createFileSync(
      path: string,
      flag: string,
      mode: number,
      options: CreationOptions,
  ): File

  Create the file at path with the given options. Then, open it with flag.

  Parameters

  • path: string
  • flag: string
  • mode: number
  • options: CreationOptions

  Returns File

isDeleted

• isDeleted(path: string): boolean

  Parameters

  • path: string

  Returns boolean

link

• link(srcpath: string, dstpath: string): Promise<void>

  Parameters

  • srcpath: string
  • dstpath: string

  Returns Promise<void>

linkSync

• linkSync(srcpath: string, dstpath: string): void

  Parameters

  • srcpath: string
  • dstpath: string

  Returns void

mkdir

• mkdir(path: string, mode: number, options: CreationOptions): Promise<void>

  Parameters

  • path: string
  • mode: number
  • options: CreationOptions

  Returns Promise<void>

mkdirSync

• mkdirSync(path: string, mode: number, options: CreationOptions): void

  Parameters

  • path: string
  • mode: number
  • options: CreationOptions

  Returns void

openFile

• openFile(path: string, flag: string): Promise<File<FileSystem>>

  Opens the file at path with flag. The file must exist.

  Parameters

  • path: string

    The path to open.
  • flag: string

    The flag to use when opening the file.

  Returns Promise<File<FileSystem>>

openFileSync

• openFileSync(path: string, flag: string): File

  Opens the file at path with flag. The file must exist.

  Parameters

  • path: string

    The path to open.
  • flag: string

    The flag to use when opening the file.

  Returns File

read

• read(
      path: string,
      buffer: Uint8Array,
      offset: number,
      end: number,
  ): Promise<void>

  Reads into a buffer

  Parameters

  • path: string
  • buffer: Uint8Array

    The buffer to read into. You must set the byteOffset and byteLength appropriately!
  • offset: number

    The offset into the file to start reading from
  • end: number

    The position in the file to stop reading

  Returns Promise<void>

readdir

• readdir(path: string): Promise<string[]>

  Parameters

  • path: string

  Returns Promise<string[]>

readdirSync

• readdirSync(path: string): string[]

  Parameters

  • path: string

  Returns string[]

readSync

• readSync(path: string, buffer: Uint8Array, offset: number, end: number): void

  Reads into a buffer

  Parameters

  • path: string
  • buffer: Uint8Array

    The buffer to read into. You must set the byteOffset and byteLength appropriately!
  • offset: number

    The offset into the file to start reading from
  • end: number

    The position in the file to stop reading

  Returns void

ready

• ready(): Promise<void>

  Returns Promise<void>

rename

• rename(oldPath: string, newPath: string): Promise<void>

  Parameters

  • oldPath: string
  • newPath: string

  Returns Promise<void>

renameSync

• renameSync(oldPath: string, newPath: string): void

  Parameters

  • oldPath: string
  • newPath: string

  Returns void

rmdir

• rmdir(path: string): Promise<void>

  Parameters

  • path: string

  Returns Promise<void>

rmdirSync

• rmdirSync(path: string): void

  Parameters

  • path: string

  Returns void

stat

• stat(path: string): Promise<Stats>

  Parameters

  • path: string

  Returns Promise<Stats>

statSync

• statSync(path: string): Stats

  Parameters

  • path: string

  Returns Stats

streamRead

• streamRead(path: string, options: StreamOptions): ReadableStream

  Read a file using a stream.

  Parameters

  • path: string
  • options: StreamOptions

  Returns ReadableStream

streamWrite

• streamWrite(path: string, options: StreamOptions): WritableStream

  Write a file using stream.

  Parameters

  • path: string
  • options: StreamOptions

  Returns WritableStream

sync

• sync(path: string, data: Uint8Array, stats: Readonly<InodeLike>): Promise<void>

  Parameters

  • path: string
  • data: Uint8Array
  • stats: Readonly<InodeLike>

  Returns Promise<void>

syncSync

• syncSync(path: string, data: Uint8Array, stats: Readonly<InodeLike>): void

  Parameters

  • path: string
  • data: Uint8Array
  • stats: Readonly<InodeLike>

  Returns void

unlink

• unlink(path: string): Promise<void>

  Parameters

  • path: string

  Returns Promise<void>

unlinkSync

• unlinkSync(path: string): void

  Parameters

  • path: string

  Returns void

usage

• usage(): UsageInfo

  Returns UsageInfo

  Todo

  Consider trying to track information on the writable as well

write

• write(path: string, buffer: Uint8Array, offset: number): Promise<void>

  Writes a buffer to a file

  Parameters

  • path: string
  • buffer: Uint8Array

    The buffer to write. You must set the byteOffset and byteLength appropriately!
  • offset: number

    The offset in the file to start writing

  Returns Promise<void>

writeSync

• writeSync(path: string, buffer: Uint8Array, offset: number): void

  Writes a buffer to a file

  Parameters

  • path: string
  • buffer: Uint8Array

    The buffer to write. You must set the byteOffset and byteLength appropriately!
  • offset: number

    The offset in the file to start writing

  Returns void