Class BaseEntry

A base class for entries. This class is not meant to be used directly, but rather to be extended by other classes.

This class provides static methods for checking whether an entry is a file or a directory, and for creating an entry from entry data.

Hierarchy

BaseEntry
- FileEntry
- DirectoryEntry

Index

Constructors

Methods

fromData isDirectory isEntry isFile

Constructors

constructor

new BaseEntry(): BaseEntry
Returns BaseEntry

Methods

`Static` fromData

fromData(entryData): FileEntry
Creates an entry from the given entry data.
Parameters
- entryData: FileEntryData
  
  The entry data to create the entry from.
Returns FileEntry
- Defined in entries.ts:24
fromData(entryData): DirectoryEntry
Parameters
- entryData: DirectoryEntryData
Returns DirectoryEntry
- Defined in entries.ts:25
fromData(entryData): Entry
Parameters
- entryData: EntryData
Returns Entry
- Defined in entries.ts:26

`Static` isDirectory

isDirectory(entry): entry is DirectoryEntry
Checks whether the given entry is a directory.
Parameters
- entry: BaseEntry
  
  The entry or entry data to check.
Returns entry is DirectoryEntry
- Defined in entries.ts:49
isDirectory(entry): entry is DirectoryEntryData
Parameters
- entry: EntryData
Returns entry is DirectoryEntryData
- Defined in entries.ts:50

`Static` isEntry

isEntry(entry): entry is Entry
Checks wether the given value is an entry.
Parameters
- entry: unknown
  
  The value to check.
Returns entry is Entry
- Defined in entries.ts:41

`Static` isFile

isFile(entry): entry is FileEntry
Checks whether the given entry is a file.
Parameters
- entry: BaseEntry
  
  The entry or entry data to check.
Returns entry is FileEntry
- Defined in entries.ts:59
isFile(entry): entry is FileEntryData
Parameters
- entry: EntryData
Returns entry is FileEntryData
- Defined in entries.ts:60

Generated using TypeDoc