ISPO SDK
    Preparing search index...

    Interface ProjectFileApi

    Markdown
    interface ProjectFileApi {
        external: FsExternalApi;
        delete(path: string): Promise<void>;
        list(path?: string): Promise<string[]>;
        read(path: string): Promise<string>;
        readBinary(path: string): Promise<Uint8Array<ArrayBufferLike>>;
        write(path: string, content: string): Promise<void>;
        writeBinary(path: string, content: Uint8Array): Promise<void>;
    }
    Index
    external
    delete list read readBinary write writeBinary
    external: FsExternalApi

    Borrowed folders on the user's machine (spec §7.4). A completely separate authority from the rest of fs: these calls never touch your private project data, and the rest of fs never reaches a borrowed directory.

    • Parameters

      • path: string

      Returns Promise<void>

      Retained only for one-shot legacy importers.

    • Parameters

      • Optionalpath: string

      Returns Promise<string[]>

      Retained only for one-shot legacy importers.

    • Parameters

      • path: string

      Returns Promise<string>

      Retained only for one-shot legacy importers.

    • Parameters

      • path: string

      Returns Promise<Uint8Array<ArrayBufferLike>>

      Retained only for one-shot legacy importers.

    • Parameters

      • path: string
      • content: string

      Returns Promise<void>

      Retained only for one-shot legacy importers.

    • Parameters

      • path: string
      • content: Uint8Array

      Returns Promise<void>

      Retained only for one-shot legacy importers.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods