Phials developer documentation
User guide
AI Notice: Most documentation right now was auto-generated by an LLM. Handwritten documentation will be implemented over time on the road to 1.0

FileEntry

Core file entry interface - file-type agnostic Represents a file or directory in the filesystem

Signature

interface FileEntry {
    name: string;
    path: string;
    is_file: boolean;
    is_dir: boolean;
    is_vial: boolean;
    isChildVial?: boolean;
    isInRecursiveVial?: boolean;
    size: number;
    created?: number | null;
    modified?: number | null;
    exif_data: Record<string, string> | null;
    mimeType?: string;
    category?: FileCategory;
}

Members

NameTypeRequiredDescription
namestringyes
pathstringyes
is_filebooleanyes
is_dirbooleanyes
is_vialbooleanyes
isChildVialbooleannoNested vial folder when listing inside a parent vial
isInRecursiveVialbooleannoListed directory is under a recursive vial (metadata from ancestor root)
sizenumberyes
creatednumber | nullno
modifiednumber | nullno
exif_dataRecord<string, string> | nullyesRaw metadata from filesystem/EXIF - parsed lazily by plugins
mimeTypestringnoComputed lazily based on extension
categoryFileCategorynoComputed lazily based on extension