@stryke/fs/dist/is-file.d.mts

A package containing various file system utilities that expand the functionality of NodeJs's built-in `fs` module.

//#region src/is-file.d.ts
/**
 * Check if the given path is a file.
 *
 * @param path - The location to check
 * @param additionalPath - An optional additional path to add to the start of the path
 * @returns An indicator specifying if the path is a file
 */
declare function isFile(path: string, additionalPath?: string): boolean;
/**
 * Check if the given path is a directory.
 *
 * @param path - The location to check
 * @param additionalPath - An optional additional path to add to the start of the path
 * @returns An indicator specifying if the path is a directory
 */
declare function isDirectory(path: string, additionalPath?: string): boolean;
/**
 * Check if the given path is a file . Does not dereference symbolic links.
 *
 * @param path - The location to check
 * @param additionalPath - An optional additional path to add to the start of the path
 * @returns An indicator specifying if the path is a file
 */
declare const isFileSymlink: (path: string, additionalPath?: string) => boolean;
/**
 * Check if the given path is a directory. Does not dereference symbolic links.
 *
 * @param path - The location to check
 * @param additionalPath - An optional additional path to add to the start of the path
 * @returns An indicator specifying if the path is a directory
 */
declare const isDirectorySymlink: (path: string, additionalPath?: string) => boolean;
//#endregion
export { isDirectory, isDirectorySymlink, isFile, isFileSymlink };
//# sourceMappingURL=is-file.d.mts.map