@stryke/path/dist/is-equal.d.mts

A package containing various utilities that expand the functionality of NodeJs's built-in `path` module

//#region src/is-equal.d.ts
interface IsEqualOptions {
  /**
   * Whether to ignore case sensitivity when comparing paths.
   * @default false
   */
  ignoreCase?: boolean;
}
/**
 * Check if two paths are equal.
 *
 * @example
 * ```ts
 * isEqual("/home/user/project/src/index.ts", "/home/user/project/src/index.ts");
 * // returns true
 * isEqual("/home/user/project/src/index.ts", "/home/user/project");
 * // returns false
 * isEqual("/home/user/project/src/index.ts", "/home/user/project/src/other");
 * // returns false
 * isEqual("/home/user/project/src/index.ts", "/home/user/other");
 * // returns false
 * isEqual("/home/user/project/src/index.ts", "/home/user/project/src/index.ts");
 * // returns true
 * isEqual("/home/user/project/src/index.ts", "/home/user/project/src/index.ts", { ignoreCase: true });
 * // returns true
 * isEqual("/home/user/project/src/index.ts", "/home/user/project/src/INDEX.TS", { ignoreCase: true });
 * // returns true
 * isEqual("/home/user/project/src/index.ts", "/home/user/project/src/INDEX.TS");
 * // returns false
 * isEqual("/home/user/project/src/index.ts", "/home/user/project/src/index.ts/");
 * // returns true
 * isEqual("/home/user/project/src/index.ts", "/home/user/project/src/index.ts/", { ignoreCase: true });
 * // returns true
 * ```
 *
 * @param path1 - The first path to compare.
 * @param path2 - The second path to compare.
 * @returns `true` if `path1` is equal to `path2`, otherwise `false`.
 */
declare function isEqual(path1: string, path2: string, options?: IsEqualOptions): boolean;
//#endregion
export { IsEqualOptions, isEqual };
//# sourceMappingURL=is-equal.d.mts.map