mise API - v0.0.0
    Preparing search index...

    Interface BackendFilesystem

    The backend's filesystem, as the core's listings, globbing and completion read it.

    interface BackendFilesystem {
        cache?: ListingCache;
        cache_holds?: (path: string) => boolean;
        dispatcher: VFSDispatcher;
        folder_enter?: (
            logicalPath: string,
            pathArg: string,
        ) => Promise<FolderEntry>;
        longRows_annotate?: (items: ListingItem[]) => Promise<ListingItem[]>;
        path_physical?: (path: string) => Promise<string>;
        segment_title?: (segment: string) => Promise<string | null>;
        structural?: readonly string[];
        unreadLinks_take?: () => Promise<string[]>;
    }
    Index
    cache? cache_holds? dispatcher folder_enter? longRows_annotate? path_physical? segment_title? structural? unreadLinks_take?
    cache?: ListingCache

    Where listings are kept between reads; absent, every listing is read afresh.

    cache_holds?: (path: string) => boolean

    Whether a path's listing may be kept (ChRIS: not under /proc, which keeps its own); absent, every path may.

    dispatcher: VFSDispatcher

    Every path goes through it: the backend's mounts and its fallback. The core adds its own mounts.

    folder_enter?: (logicalPath: string, pathArg: string) => Promise<FolderEntry>

    Enters a folder outside the mounts (cd): whether it is one, and where the session then stands. Absent, a path that lists is a folder.

    longRows_annotate?: (items: ListingItem[]) => Promise<ListingItem[]>

    What a long listing's rows carry beyond the listing (ChRIS: a feed's tags).

    path_physical?: (path: string) => Promise<string>

    A folder as the filesystem holds it, links followed, for globbing beneath it; absent, the path as given.

    segment_title?: (segment: string) => Promise<string | null>

    The title a path segment shows under pwd --title (ChRIS: a feed's name), or null for none.

    structural?: readonly string[]

    Paths that are always folders, entered without asking (beside the mounts and the folders above them).

    unreadLinks_take?: () => Promise<string[]>

    The folders whose links the last walk could not read, taken (and so cleared): a listing that fails says the path was walked as written.

    Settings
    Member Visibility

    On This Page
    Properties