AutoMovie API
    Preparing search index...

    Interface IAutoMovieCaptureStorage

    The files a capture reads and writes, injected by its host so the capture core reaches no file system itself.

    The capture host supplies these five file operations. Node fs/promises and Map-backed test storage satisfy this structural port without importing their types. Paths are slash-joined host strings; request parsing owns round-name admission and the folder validates plain claimed file names. The storage port itself accepts arbitrary paths and provides no sandbox. mkdir's return value is deliberately ignored, so it remains unknown.

    interface IAutoMovieCaptureStorage {
        mkdir(path: string, options: { recursive: true }): Promise<unknown>;
        readdir(path: string): Promise<string[]>;
        readFile(path: string): Promise<Uint8Array<ArrayBufferLike>>;
        rm(path: string, options: { force: true }): Promise<void>;
        writeFile(
            path: string,
            data: string | Uint8Array<ArrayBufferLike>,
        ): Promise<void>;
    }
    Index
    • Create a folder and any missing parent; an existing folder is kept.

      Parameters

      • path: string
      • options: { recursive: true }
        • recursive: true

          Create any missing parent directories as well as the destination.

      Returns Promise<unknown>

    • Delete a file; with force, a path that does not exist is not an error.

      Parameters

      • path: string
      • options: { force: true }
        • force: true

          Treat an absent file as successful deletion; other storage errors still reject.

      Returns Promise<void>

    • Write a file whole, replacing one of the same path; text is written as UTF-8.

      Parameters

      • path: string
      • data: string | Uint8Array<ArrayBufferLike>

      Returns Promise<void>