@oazmi/kitchensink - v0.10.1
    Preparing search index...

    Interface FsEntryRecord

    provides information about the nature of a filesystem entry (file, folder, or a symbolic link) scanned by the readDir function.

    interface FsEntryRecord {
        isFile: boolean;
        isDirectory: boolean;
        isSymlink: boolean;
        name: string;
    }

    Hierarchy

    • Pick<FsEntryInfo, "isDirectory" | "isFile" | "isSymlink">
      • FsEntryRecord
    Index

    Properties

    isFile isDirectory isSymlink name

    Properties

    isFile: boolean

    this field is true if this info corresponds to a regular file.

    mutually exclusive with respect to isDirectory and isSymlink.

    isDirectory: boolean

    this field is true if this info corresponds to a regular folder.

    mutually exclusive with respect to isFile and isSymlink.

    isSymlink: boolean

    this field is true if this info corresponds to a symbolic-link (symlink).

    mutually exclusive with respect to isFile and isDirectory.

    name: string

    the name of the filesystem entry, without any trailing slashes, nor any leading dot-slashes; not even when the entry is a sub-directory (i.e. you will have to check the isDirectory flag to distinguish files from folders).

    all names are all relative to the directory that you scan.

    Settings

    Member Visibility

    On This Page

    Properties