Class UnmutexedOverlayFSInternal

constructor

• new UnmutexedOverlayFS(__namedParameters): UnmutexedOverlayFS

• Parameters

  • __namedParameters: OverlayOptions

  Returns UnmutexedOverlayFS

Readonlyreadable

Readonlywritable

_initialize

• _initialize(): Promise<void>
• Internal

  Called once to load up metadata stored on the writable file system.

  Returns Promise<void>

createFile

• createFile(path, flag, mode): Promise<File<FileSystem>>

• Create the file at path with mode. Then, open it with flag.

  Parameters

  • path: string
  • flag: string
  • mode: number

  Returns Promise<File<FileSystem>>

createFileSync

• createFileSync(path, flag, mode): File<FileSystem>

• Create the file at path with mode. Then, open it with flag.

  Parameters

  • path: string
  • flag: string
  • mode: number

  Returns File<FileSystem>

getDeletionLog

• getDeletionLog(): string

• Returns string

link

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

• Parameters

  • srcpath: string
  • dstpath: string

  Returns Promise<void>

linkSync

• linkSync(srcpath, dstpath): void

• Parameters

  • srcpath: string
  • dstpath: string

  Returns void

metadata

• metadata(): FileSystemMetadata

• Get metadata about the current file system

  Returns FileSystemMetadata

mkdir

• mkdir(path, mode): Promise<void>

• Parameters

  • path: string
  • mode: number

  Returns Promise<void>

mkdirSync

• mkdirSync(path, mode): void

• Parameters

  • path: string
  • mode: number

  Returns void

openFile

• openFile(path, flag): 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, flag): 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 File<FileSystem>

readdir

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

• Parameters

  • path: string

  Returns Promise<string[]>

readdirSync

• readdirSync(path): string[]

• Parameters

  • path: string

  Returns string[]

ready

• ready(): Promise<void>

• Returns Promise<void>

rename

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

• Parameters

  • oldPath: string
  • newPath: string

  Returns Promise<void>

renameSync

• renameSync(oldPath, newPath): void

• Parameters

  • oldPath: string
  • newPath: string

  Returns void

restoreDeletionLog

• restoreDeletionLog(log): Promise<void>

• Parameters

  • log: string

  Returns Promise<void>

rmdir

• rmdir(path): Promise<void>

• Parameters

  • path: string

  Returns Promise<void>

rmdirSync

• rmdirSync(path): void

• Parameters

  • path: string

  Returns void

stat

• stat(path): Promise<Stats>

• Parameters

  • path: string

  Returns Promise<Stats>

statSync

• statSync(path): Stats

• Parameters

  • path: string

  Returns Stats

sync

• sync(path, data, stats): Promise<void>

• Parameters

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

  Returns Promise<void>

syncSync

• syncSync(path, data, stats): void

• Parameters

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

  Returns void

unlink

• unlink(path): Promise<void>

• Parameters

  • path: string

  Returns Promise<void>

unlinkSync

• unlinkSync(path): void

• Parameters

  • path: string

  Returns void