Documentation
    Preparing search index...

    Interface FsBackend

    Filesystem operations supplied to the NAP-FS service.

    interface FsBackend {
        close?(): void;
        info(windowId: string): FsInfo | Promise<FsInfo>;
        list(
            windowId: string,
            path: string,
        ): FsDirectoryEntry[] | Promise<FsDirectoryEntry[]>;
        mkdir(
            windowId: string,
            path: string,
            options?: FsMkdirOptions,
        ): void | Promise<void>;
        move(
            windowId: string,
            fromPath: string,
            toPath: string,
        ): void | Promise<void>;
        onWindowDestroyed?(windowId: string): void;
        pickDirectory(
            windowId: string,
            options?: FsPickOptions,
        ): FsPickResult | Promise<FsPickResult>;
        pickFile(
            windowId: string,
            options?: FsPickOptions,
        ): FsPickResult | Promise<FsPickResult>;
        pickFiles(
            windowId: string,
            options?: FsPickOptions,
        ): FsPickResult | Promise<FsPickResult>;
        pickSaveFile(
            windowId: string,
            options?: FsPickOptions,
        ): FsPickResult | Promise<FsPickResult>;
        read(
            windowId: string,
            path: string,
            options?: FsReadOptions,
        ): FsReadResult | Promise<FsReadResult>;
        remove(
            windowId: string,
            path: string,
            recursive?: boolean,
        ): void | Promise<void>;
        stat(windowId: string, path: string): FsMetadata | Promise<FsMetadata>;
        watch(
            windowId: string,
            path: string,
            options: FsWatchOptions | undefined,
            onChange: (change: FsBackendChange) => void,
        ): FsBackendWatch | Promise<FsBackendWatch>;
        write(
            windowId: string,
            path: string,
            data: string,
            options?: FsWriteOptions,
        ): FsWriteResult | Promise<FsWriteResult>;
    }
    Index

    Methods

    • Parameters

      • windowId: string
      • path: string

      Returns FsDirectoryEntry[] | Promise<FsDirectoryEntry[]>

    • Parameters

      • windowId: string
      • path: string
      • Optionaloptions: FsMkdirOptions

      Returns void | Promise<void>

    • Parameters

      • windowId: string
      • fromPath: string
      • toPath: string

      Returns void | Promise<void>

    • Release session-scoped backend state for a destroyed runtime window.

      Parameters

      • windowId: string

      Returns void

    • Parameters

      • windowId: string
      • Optionaloptions: FsPickOptions

      Returns FsPickResult | Promise<FsPickResult>

    • Parameters

      • windowId: string
      • Optionaloptions: FsPickOptions

      Returns FsPickResult | Promise<FsPickResult>

    • Parameters

      • windowId: string
      • Optionaloptions: FsPickOptions

      Returns FsPickResult | Promise<FsPickResult>

    • Parameters

      • windowId: string
      • Optionaloptions: FsPickOptions

      Returns FsPickResult | Promise<FsPickResult>

    • Parameters

      • windowId: string
      • path: string
      • Optionaloptions: FsReadOptions

      Returns FsReadResult | Promise<FsReadResult>

    • Parameters

      • windowId: string
      • path: string
      • Optionalrecursive: boolean

      Returns void | Promise<void>

    • Parameters

      • windowId: string
      • path: string

      Returns FsMetadata | Promise<FsMetadata>

    • Parameters

      • windowId: string
      • path: string
      • data: string
      • Optionaloptions: FsWriteOptions

      Returns FsWriteResult | Promise<FsWriteResult>