Class OverlayFSInternal

OverlayFS makes a read-only filesystem writable by storing writes on a second, writable file system. Deletes are persisted via metadata stored on the writable file system.

Hierarchy

Constructors

Properties

Accessors

  • get isLocked(): boolean
  • Internal

    Whether path is locked

    Returns boolean

Methods

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

    Parameters

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

    Returns Promise<File<FileSystem>>

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

    Parameters

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

    Returns File<FileSystem>

  • Test whether or not path exists.

    Parameters

    • path: string

    Returns Promise<boolean>

  • Test whether or not path exists.

    Parameters

    • path: string

    Returns boolean

  • Parameters

    • srcpath: string
    • dstpath: string

    Returns Promise<void>

  • Parameters

    • srcpath: string
    • dstpath: string

    Returns void

  • Internal

    Locks path asynchronously. If the path is currently locked, waits for it to be unlocked.

    Parameters

    • path: string
    • syscall: string

    Returns Promise<MutexLock>

  • Internal

    Locks path asynchronously. If the path is currently locked, an error will be thrown

    Parameters

    • path: string
    • syscall: string

    Returns MutexLock

  • Parameters

    • path: string
    • mode: number

    Returns Promise<void>

  • Parameters

    • path: string
    • mode: number

    Returns void

  • 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>>

  • 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>

  • Parameters

    • path: string

    Returns Promise<string[]>

  • Parameters

    • path: string

    Returns string[]

  • Returns Promise<void>

  • Parameters

    • oldPath: string
    • newPath: string

    Returns Promise<void>

  • Parameters

    • oldPath: string
    • newPath: string

    Returns void

  • Parameters

    • path: string

    Returns Promise<void>

  • Parameters

    • path: string

    Returns void

  • Parameters

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

    Returns Promise<void>

  • Parameters

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

    Returns void

  • Parameters

    • path: string

    Returns Promise<void>

  • Parameters

    • path: string

    Returns void