Home > @rushstack/node-core-library > Path
Common operations for manipulating file and directory paths.
export declare class Path
This API is intended to eventually be a complete replacement for the NodeJS "path" API.
|convertToBackslashes(inputPath)||Replaces POSIX-style slashes with Windows-style backslashes|
|convertToPlatformDefault(inputPath)||Replaces slashes or backslashes with the appropriate slash for the current operating system.|
|convertToSlashes(inputPath)||Replaces Windows-style backslashes with POSIX-style slashes.|
|formatConcisely(options)||Formats a path to look nice for reporting purposes.|
|formatFileLocation(options)||Formats a file location to look nice for reporting purposes.|
|isDownwardRelative(inputPath)||Returns true if the specified path is a relative path and does not use |
|isEqual(path1, path2)||Returns true if |
|isUnder(childPath, parentFolderPath)||Returns true if "childPath" is located inside the "parentFolderPath" folder or one of its child folders. Note that "parentFolderPath" is not considered to be under itself. The "childPath" can refer to any type of file system object.|
|isUnderOrEqual(childPath, parentFolderPath)||Returns true if "childPath" is equal to "parentFolderPath", or if it is inside that folder or one of its children. The "childPath" can refer to any type of file system object.|