path-class 0.7.1 → 0.7.2

package/dist/lib/path-class/Path.d.ts

@@ -1,5 +1,5 @@
-import { cp, lstat, mkdir, rm, stat, symlink, writeFile } from "node:fs/promises";
-import type { readDirType, readFileType } from "./modifiedNodeTypes";
+import { cp, mkdir, rm, symlink, writeFile } from "node:fs/promises";
+import type { lstatType, readDirType, readFileType, statType } from "./modifiedNodeTypes";
 export declare class Path {
     #private;
     /**
@@ -86,8 +86,8 @@ export declare class Path {
     readDir: typeof readDirType;
     /** Returns the destination path. */
     symlink(target: string | URL | Path, type?: Parameters<typeof symlink>[2]): Promise<Path>;
-    stat(options?: Parameters<typeof stat>[1]): ReturnType<typeof stat>;
-    lstat(options?: Parameters<typeof lstat>[1]): ReturnType<typeof lstat>;
+    stat: typeof statType;
+    lstat: typeof lstatType;
     static get homedir(): Path;
     static xdg: {
         cache: Path;

package/dist/lib/path-class/chunks/{chunk-VW3LCF27.js → chunk-DNNABIUU.js}

@@ -276,15 +276,15 @@ var Path = class _Path {
     );
     return targetPath;
   }
-  stat(options) {
-    return stat(this.path, options);
-  }
+  // biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.
+  stat = (...options) => stat(this.#path, ...options);
   // I don't think `lstat` is a great name, but it does match the
   // well-established canonical system call. So in this case we keep the
   // awkward abbreviation.
-  lstat(options) {
-    return lstat(this.path, options);
-  }
+  lstat = (...options) => (
+    // biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.
+    lstat(this.#path, ...options)
+  );
   static get homedir() {
     return new _Path(homedir());
   }
@@ -336,4 +336,4 @@ export {
   stringifyIfPath,
   mustNotHaveTrailingSlash
 };
-//# sourceMappingURL=chunk-VW3LCF27.js.map
+//# sourceMappingURL=chunk-DNNABIUU.js.map

package/dist/lib/path-class/chunks/chunk-DNNABIUU.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../src/Path.ts"],
+  "sourcesContent": ["import {\n  cp,\n  lstat,\n  mkdir,\n  mkdtemp,\n  readdir,\n  readFile,\n  rename,\n  rm,\n  stat,\n  symlink,\n  writeFile,\n} from \"node:fs/promises\";\nimport { homedir, tmpdir } from \"node:os\";\nimport { basename, dirname, extname, join } from \"node:path\";\nimport { fileURLToPath, pathToFileURL } from \"node:url\";\nimport {\n  xdgCache,\n  xdgConfig,\n  xdgData,\n  xdgRuntime,\n  xdgState,\n} from \"xdg-basedir\";\nimport type {\n  lstatType,\n  readDirType,\n  readFileType,\n  statType,\n} from \"./modifiedNodeTypes\";\n\n// Note that (non-static) functions in this file are defined using `function(\u2026)\n// { \u2026 }` rather than arrow functions, specifically because we want `this` to\n// operate on the `Path` instance.\n\nexport class Path {\n  // @ts-expect-error ts(2564): False positive. https://github.com/microsoft/TypeScript/issues/32194\n  #path: string;\n  /**\n   * If `path` is a string starting with `file:///`, it will be parsed as a file URL.\n   */\n  constructor(path: string | URL | Path) {\n    this.#setNormalizedPath(Path.#pathlikeToString(path));\n  }\n\n  /**\n   * Similar to `new URL(path, base)`, but accepting and returning `Path` objects.\n   * Note that `base` must be one of:\n   *\n   * - a valid second argument to `new URL(\u2026)`.\n   * - a `Path` representing an absolute path.\n   *\n   */\n  static resolve(path: string | URL | Path, base: string | URL | Path): Path {\n    const baseURL = (() => {\n      if (!(base instanceof Path)) {\n        return base;\n      }\n      if (!base.isAbsolutePath()) {\n        throw new Error(\n          \"The `base` arg to `Path.resolve(\u2026)` must be an absolute path.\",\n        );\n      }\n      return pathToFileURL(base.#path);\n    })();\n    return new Path(new URL(Path.#pathlikeToString(path), baseURL));\n  }\n\n  static #pathlikeToString(path: string | URL | Path): string {\n    if (path instanceof Path) {\n      return path.#path;\n    }\n    if (path instanceof URL) {\n      return fileURLToPath(path);\n    }\n    if (typeof path === \"string\") {\n      // TODO: allow turning off this heuristic?\n      if (path.startsWith(\"file:///\")) {\n        return fileURLToPath(path);\n      }\n      return path;\n    }\n    throw new Error(\"Invalid path\");\n  }\n\n  #setNormalizedPath(path: string): void {\n    this.#path = join(path);\n  }\n\n  isAbsolutePath(): boolean {\n    return this.#path.startsWith(\"/\");\n  }\n\n  toFileURL(): URL {\n    if (!this.isAbsolutePath()) {\n      throw new Error(\n        \"Tried to convert to file URL when the path is not absolute.\",\n      );\n    }\n    return pathToFileURL(this.#path);\n  }\n\n  /**\n   * The `Path` can have a trailing slash, indicating that it represents a\n   * directory. (If there is no trailing slash, it can represent either a file\n   * or a directory.)\n   *\n   * Some operations will refuse to treat a directory path as a file path. This\n   * function identifies such paths.\n   */\n  hasTrailingSlash(): boolean {\n    // TODO: handle Windows semantically\n    return this.#path.endsWith(\"/\");\n  }\n\n  /**\n   * Same as `.toString()`, but more concise.\n   */\n  get path() {\n    return this.#path;\n  }\n\n  toString(): string {\n    return this.#path;\n  }\n\n  /** Constructs a new path by appending the given path segments.\n   * This follows `node` semantics for absolute paths: leading slashes in the given descendant segments are ignored.\n   */\n  join(...segments: (string | Path)[]): Path {\n    const segmentStrings = segments.map((segment) =>\n      segment instanceof Path ? segment.path : segment,\n    );\n    return new Path(join(this.#path, ...segmentStrings));\n  }\n\n  extendBasename(suffix: string): Path {\n    const joinedSuffix = join(suffix);\n    if (joinedSuffix !== basename(joinedSuffix)) {\n      throw new Error(\"Invalid suffix to extend file name.\");\n    }\n    // TODO: join basename and dirname instead?\n    return new Path(this.#path + joinedSuffix);\n  }\n\n  get parent(): Path {\n    return new Path(dirname(this.#path));\n  }\n\n  // Normally I'd stick with `node`'s name, but I think `.dirname` is a\n  // particularly poor name. So we support `.dirname` for discovery but mark it\n  // as deprecated, even if it will never be removed.\n  /** @deprecated Alias for `.parent`. */\n  get dirname(): Path {\n    return this.parent;\n  }\n\n  get basename(): Path {\n    return new Path(basename(this.#path));\n  }\n\n  get extension(): string {\n    mustNotHaveTrailingSlash(this);\n    return extname(this.#path);\n  }\n\n  // Normally I'd stick with `node`'s name, but I think `.extname` is a\n  // particularly poor name. So we support `.extname` for discovery but mark it\n  // as deprecated, even if it will never be removed.\n  /** @deprecated Alias for `.extension`. */\n  get extname(): string {\n    return this.extension;\n  }\n\n  // TODO: find a neat way to dedup with the sync version?\n  async exists(constraints?: {\n    mustBe: \"file\" | \"directory\";\n  }): Promise<boolean> {\n    let stats: Awaited<ReturnType<typeof stat>>;\n    try {\n      stats = await stat(this.#path);\n      // biome-ignore lint/suspicious/noExplicitAny: TypeScript limitation\n    } catch (e: any) {\n      if (e.code === \"ENOENT\") {\n        return false;\n      }\n      throw e;\n    }\n    if (!constraints?.mustBe) {\n      return true;\n    }\n    switch (constraints?.mustBe) {\n      case \"file\": {\n        mustNotHaveTrailingSlash(this);\n        if (stats.isFile()) {\n          return true;\n        }\n        throw new Error(`Path exists but is not a file: ${this.#path}`);\n      }\n      case \"directory\": {\n        if (stats.isDirectory()) {\n          return true;\n        }\n        throw new Error(`Path exists but is not a directory: ${this.#path}`);\n      }\n      default: {\n        throw new Error(\"Invalid path type constraint\");\n      }\n    }\n  }\n\n  async existsAsFile(): Promise<boolean> {\n    return this.exists({ mustBe: \"file\" });\n  }\n\n  async existsAsDir(): Promise<boolean> {\n    return this.exists({ mustBe: \"directory\" });\n  }\n\n  // I don't think `mkdir` is a great name, but it does match the\n  // well-established canonical commandline name. So in this case we keep the\n  // awkward abbreviation.\n  /** Defaults to `recursive: true`. */\n  async mkdir(options?: Parameters<typeof mkdir>[1]): Promise<Path> {\n    const optionsObject = (() => {\n      if (typeof options === \"string\" || typeof options === \"number\") {\n        return { mode: options };\n      }\n      return options ?? {};\n    })();\n    await mkdir(this.#path, { recursive: true, ...optionsObject });\n    return this;\n  }\n\n  // TODO: check idempotency semantics when the destination exists and is a folder.\n  /** Returns the destination path. */\n  async cp(\n    destination: string | URL | Path,\n    options?: Parameters<typeof cp>[2],\n  ): Promise<Path> {\n    await cp(this.#path, new Path(destination).#path, options);\n    return new Path(destination);\n  }\n\n  // TODO: check idempotency semantics when the destination exists and is a folder.\n  async rename(destination: string | URL | Path): Promise<void> {\n    await rename(this.#path, new Path(destination).#path);\n  }\n\n  /** Create a temporary dir inside the global temp dir for the current user. */\n  static async makeTempDir(prefix?: string): Promise<Path> {\n    return new Path(\n      await mkdtemp(new Path(tmpdir()).join(prefix ?? \"js-temp-\").toString()),\n    );\n  }\n\n  async rm(options?: Parameters<typeof rm>[1]): Promise<void> {\n    await rm(this.#path, options);\n  }\n\n  /**\n   * Equivalent to:\n   *\n   *     .rm({ recursive: true, force: true, ...(options ?? {}) })\n   *\n   */\n  async rm_rf(options?: Parameters<typeof rm>[1]): Promise<void> {\n    await this.rm({ recursive: true, force: true, ...(options ?? {}) });\n  }\n\n  read: typeof readFileType = (options) =>\n    // biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.\n    readFile(this.#path, options as any) as any;\n\n  async readText(): Promise<string> {\n    return readFile(this.#path, \"utf-8\");\n  }\n\n  async readJSON<T>(): Promise<T> {\n    return JSON.parse(await this.readText());\n  }\n\n  /** Creates intermediate directories if they do not exist.\n   *\n   * Returns the original `Path` (for chaining).\n   */\n  async write(\n    data: Parameters<typeof writeFile>[1],\n    options?: Parameters<typeof writeFile>[2],\n  ): Promise<Path> {\n    await this.parent.mkdir();\n    await writeFile(this.#path, data, options);\n    return this;\n  }\n\n  /**\n   * If only `data` is provided, this is equivalent to:\n   *\n   *     .write(JSON.stringify(data, null, \"  \"));\n   *\n   * `replacer` and `space` can also be specified, making this equivalent to:\n   *\n   *     .write(JSON.stringify(data, replacer, space));\n   *\n   * Returns the original `Path` (for chaining).\n   */\n  async writeJSON<T>(\n    data: T,\n    replacer: Parameters<typeof JSON.stringify>[1] = null,\n    space: Parameters<typeof JSON.stringify>[2] = \"  \",\n  ): Promise<Path> {\n    await this.write(JSON.stringify(data, replacer, space));\n    return this;\n  }\n\n  // Normally we'd add a `@deprecated` alias named `.readdir`, but that would\n  // differ only by capitalization of a single non-leading character. This can\n  // be a bit confusing, especially when autocompleting. So for this function in\n  // particular we don't include an alias.\n  readDir: typeof readDirType = (options) =>\n    // biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.\n    readdir(this.#path, options as any) as any;\n\n  /** Returns the destination path. */\n  async symlink(\n    target: string | URL | Path,\n    type?: Parameters<typeof symlink>[2],\n  ): Promise<Path> {\n    const targetPath = new Path(target);\n    await symlink(\n      this.path,\n      targetPath.path,\n      type as Exclude<Parameters<typeof symlink>[2], undefined>, // \uD83E\uDD37\n    );\n    return targetPath;\n  }\n\n  // biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.\n  stat: typeof statType = (...options) => stat(this.#path, ...options) as any;\n\n  // I don't think `lstat` is a great name, but it does match the\n  // well-established canonical system call. So in this case we keep the\n  // awkward abbreviation.\n  lstat: typeof lstatType = (...options) =>\n    // biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.\n    lstat(this.#path, ...options) as any;\n\n  static get homedir(): Path {\n    return new Path(homedir());\n  }\n\n  static xdg = {\n    cache: new Path(xdgCache ?? Path.homedir.join(\".cache\")),\n    config: new Path(xdgConfig ?? Path.homedir.join(\".config\")),\n    data: new Path(xdgData ?? Path.homedir.join(\".local/share\")),\n    state: new Path(xdgState ?? Path.homedir.join(\".local/state\")),\n    /**\n     * {@link Path.xdg.runtime} does not have a default value. Consider\n     * {@link Path.xdg.runtimeWithStateFallback} if you need a fallback but do not have a particular fallback in mind.\n     */\n    runtime: xdgRuntime ? new Path(xdgRuntime) : undefined,\n    runtimeWithStateFallback: xdgRuntime\n      ? new Path(xdgRuntime)\n      : new Path(xdgState ?? Path.homedir.join(\".local/state\")),\n  };\n\n  /** Chainable function to print the path. Prints the same as:\n   *\n   *     if (args.length > 0) {\n   *      console.log(...args);\n   *     }\n   *     console.log(this.path);\n   *\n   */\n  // biome-ignore lint/suspicious/noExplicitAny: This is the correct type, based on `console.log(\u2026)`.\n  debugPrint(...args: any[]): Path {\n    if (args.length > 0) {\n      console.log(...args);\n    }\n    console.log(this.#path);\n    return this;\n  }\n}\n\n/**\n * This function is useful to serialize any `Path`s in a structure to pass on to\n * functions that do not know about the `Path` class, e.g.\n *\n *     function process(args: (string | Path)[]) {\n *       const argsAsStrings = args.map(stringifyIfPath);\n *     }\n *\n */\nexport function stringifyIfPath<T>(value: T | Path): T | string {\n  if (value instanceof Path) {\n    return value.toString();\n  }\n  return value;\n}\n\nexport function mustNotHaveTrailingSlash(path: Path): void {\n  if (path.hasTrailingSlash()) {\n    throw new Error(\n      \"Path ends with a slash, which cannot be treated as a file.\",\n    );\n  }\n}\n"],
+  "mappings": ";AAAA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,SAAS,cAAc;AAChC,SAAS,UAAU,SAAS,SAAS,YAAY;AACjD,SAAS,eAAe,qBAAqB;AAC7C;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAYA,IAAM,OAAN,MAAM,MAAK;AAAA;AAAA,EAEhB;AAAA;AAAA;AAAA;AAAA,EAIA,YAAY,MAA2B;AACrC,SAAK,mBAAmB,MAAK,kBAAkB,IAAI,CAAC;AAAA,EACtD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,OAAO,QAAQ,MAA2B,MAAiC;AACzE,UAAM,WAAW,MAAM;AACrB,UAAI,EAAE,gBAAgB,QAAO;AAC3B,eAAO;AAAA,MACT;AACA,UAAI,CAAC,KAAK,eAAe,GAAG;AAC1B,cAAM,IAAI;AAAA,UACR;AAAA,QACF;AAAA,MACF;AACA,aAAO,cAAc,KAAK,KAAK;AAAA,IACjC,GAAG;AACH,WAAO,IAAI,MAAK,IAAI,IAAI,MAAK,kBAAkB,IAAI,GAAG,OAAO,CAAC;AAAA,EAChE;AAAA,EAEA,OAAO,kBAAkB,MAAmC;AAC1D,QAAI,gBAAgB,OAAM;AACxB,aAAO,KAAK;AAAA,IACd;AACA,QAAI,gBAAgB,KAAK;AACvB,aAAO,cAAc,IAAI;AAAA,IAC3B;AACA,QAAI,OAAO,SAAS,UAAU;AAE5B,UAAI,KAAK,WAAW,UAAU,GAAG;AAC/B,eAAO,cAAc,IAAI;AAAA,MAC3B;AACA,aAAO;AAAA,IACT;AACA,UAAM,IAAI,MAAM,cAAc;AAAA,EAChC;AAAA,EAEA,mBAAmB,MAAoB;AACrC,SAAK,QAAQ,KAAK,IAAI;AAAA,EACxB;AAAA,EAEA,iBAA0B;AACxB,WAAO,KAAK,MAAM,WAAW,GAAG;AAAA,EAClC;AAAA,EAEA,YAAiB;AACf,QAAI,CAAC,KAAK,eAAe,GAAG;AAC1B,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AACA,WAAO,cAAc,KAAK,KAAK;AAAA,EACjC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,mBAA4B;AAE1B,WAAO,KAAK,MAAM,SAAS,GAAG;AAAA,EAChC;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,OAAO;AACT,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,WAAmB;AACjB,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA,EAKA,QAAQ,UAAmC;AACzC,UAAM,iBAAiB,SAAS;AAAA,MAAI,CAAC,YACnC,mBAAmB,QAAO,QAAQ,OAAO;AAAA,IAC3C;AACA,WAAO,IAAI,MAAK,KAAK,KAAK,OAAO,GAAG,cAAc,CAAC;AAAA,EACrD;AAAA,EAEA,eAAe,QAAsB;AACnC,UAAM,eAAe,KAAK,MAAM;AAChC,QAAI,iBAAiB,SAAS,YAAY,GAAG;AAC3C,YAAM,IAAI,MAAM,qCAAqC;AAAA,IACvD;AAEA,WAAO,IAAI,MAAK,KAAK,QAAQ,YAAY;AAAA,EAC3C;AAAA,EAEA,IAAI,SAAe;AACjB,WAAO,IAAI,MAAK,QAAQ,KAAK,KAAK,CAAC;AAAA,EACrC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAI,UAAgB;AAClB,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAI,WAAiB;AACnB,WAAO,IAAI,MAAK,SAAS,KAAK,KAAK,CAAC;AAAA,EACtC;AAAA,EAEA,IAAI,YAAoB;AACtB,6BAAyB,IAAI;AAC7B,WAAO,QAAQ,KAAK,KAAK;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAI,UAAkB;AACpB,WAAO,KAAK;AAAA,EACd;AAAA;AAAA,EAGA,MAAM,OAAO,aAEQ;AACnB,QAAI;AACJ,QAAI;AACF,cAAQ,MAAM,KAAK,KAAK,KAAK;AAAA,IAE/B,SAAS,GAAQ;AACf,UAAI,EAAE,SAAS,UAAU;AACvB,eAAO;AAAA,MACT;AACA,YAAM;AAAA,IACR;AACA,QAAI,CAAC,aAAa,QAAQ;AACxB,aAAO;AAAA,IACT;AACA,YAAQ,aAAa,QAAQ;AAAA,MAC3B,KAAK,QAAQ;AACX,iCAAyB,IAAI;AAC7B,YAAI,MAAM,OAAO,GAAG;AAClB,iBAAO;AAAA,QACT;AACA,cAAM,IAAI,MAAM,kCAAkC,KAAK,KAAK,EAAE;AAAA,MAChE;AAAA,MACA,KAAK,aAAa;AAChB,YAAI,MAAM,YAAY,GAAG;AACvB,iBAAO;AAAA,QACT;AACA,cAAM,IAAI,MAAM,uCAAuC,KAAK,KAAK,EAAE;AAAA,MACrE;AAAA,MACA,SAAS;AACP,cAAM,IAAI,MAAM,8BAA8B;AAAA,MAChD;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAM,eAAiC;AACrC,WAAO,KAAK,OAAO,EAAE,QAAQ,OAAO,CAAC;AAAA,EACvC;AAAA,EAEA,MAAM,cAAgC;AACpC,WAAO,KAAK,OAAO,EAAE,QAAQ,YAAY,CAAC;AAAA,EAC5C;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,MAAM,SAAsD;AAChE,UAAM,iBAAiB,MAAM;AAC3B,UAAI,OAAO,YAAY,YAAY,OAAO,YAAY,UAAU;AAC9D,eAAO,EAAE,MAAM,QAAQ;AAAA,MACzB;AACA,aAAO,WAAW,CAAC;AAAA,IACrB,GAAG;AACH,UAAM,MAAM,KAAK,OAAO,EAAE,WAAW,MAAM,GAAG,cAAc,CAAC;AAC7D,WAAO;AAAA,EACT;AAAA;AAAA;AAAA,EAIA,MAAM,GACJ,aACA,SACe;AACf,UAAM,GAAG,KAAK,OAAO,IAAI,MAAK,WAAW,EAAE,OAAO,OAAO;AACzD,WAAO,IAAI,MAAK,WAAW;AAAA,EAC7B;AAAA;AAAA,EAGA,MAAM,OAAO,aAAiD;AAC5D,UAAM,OAAO,KAAK,OAAO,IAAI,MAAK,WAAW,EAAE,KAAK;AAAA,EACtD;AAAA;AAAA,EAGA,aAAa,YAAY,QAAgC;AACvD,WAAO,IAAI;AAAA,MACT,MAAM,QAAQ,IAAI,MAAK,OAAO,CAAC,EAAE,KAAK,UAAU,UAAU,EAAE,SAAS,CAAC;AAAA,IACxE;AAAA,EACF;AAAA,EAEA,MAAM,GAAG,SAAmD;AAC1D,UAAM,GAAG,KAAK,OAAO,OAAO;AAAA,EAC9B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,MAAM,SAAmD;AAC7D,UAAM,KAAK,GAAG,EAAE,WAAW,MAAM,OAAO,MAAM,GAAI,WAAW,CAAC,EAAG,CAAC;AAAA,EACpE;AAAA,EAEA,OAA4B,CAAC;AAAA;AAAA,IAE3B,SAAS,KAAK,OAAO,OAAc;AAAA;AAAA,EAErC,MAAM,WAA4B;AAChC,WAAO,SAAS,KAAK,OAAO,OAAO;AAAA,EACrC;AAAA,EAEA,MAAM,WAA0B;AAC9B,WAAO,KAAK,MAAM,MAAM,KAAK,SAAS,CAAC;AAAA,EACzC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,MACJ,MACA,SACe;AACf,UAAM,KAAK,OAAO,MAAM;AACxB,UAAM,UAAU,KAAK,OAAO,MAAM,OAAO;AACzC,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,MAAM,UACJ,MACA,WAAiD,MACjD,QAA8C,MAC/B;AACf,UAAM,KAAK,MAAM,KAAK,UAAU,MAAM,UAAU,KAAK,CAAC;AACtD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,UAA8B,CAAC;AAAA;AAAA,IAE7B,QAAQ,KAAK,OAAO,OAAc;AAAA;AAAA;AAAA,EAGpC,MAAM,QACJ,QACA,MACe;AACf,UAAM,aAAa,IAAI,MAAK,MAAM;AAClC,UAAM;AAAA,MACJ,KAAK;AAAA,MACL,WAAW;AAAA,MACX;AAAA;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA;AAAA,EAGA,OAAwB,IAAI,YAAY,KAAK,KAAK,OAAO,GAAG,OAAO;AAAA;AAAA;AAAA;AAAA,EAKnE,QAA0B,IAAI;AAAA;AAAA,IAE5B,MAAM,KAAK,OAAO,GAAG,OAAO;AAAA;AAAA,EAE9B,WAAW,UAAgB;AACzB,WAAO,IAAI,MAAK,QAAQ,CAAC;AAAA,EAC3B;AAAA,EAEA,OAAO,MAAM;AAAA,IACX,OAAO,IAAI,MAAK,YAAY,MAAK,QAAQ,KAAK,QAAQ,CAAC;AAAA,IACvD,QAAQ,IAAI,MAAK,aAAa,MAAK,QAAQ,KAAK,SAAS,CAAC;AAAA,IAC1D,MAAM,IAAI,MAAK,WAAW,MAAK,QAAQ,KAAK,cAAc,CAAC;AAAA,IAC3D,OAAO,IAAI,MAAK,YAAY,MAAK,QAAQ,KAAK,cAAc,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA,IAK7D,SAAS,aAAa,IAAI,MAAK,UAAU,IAAI;AAAA,IAC7C,0BAA0B,aACtB,IAAI,MAAK,UAAU,IACnB,IAAI,MAAK,YAAY,MAAK,QAAQ,KAAK,cAAc,CAAC;AAAA,EAC5D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,cAAc,MAAmB;AAC/B,QAAI,KAAK,SAAS,GAAG;AACnB,cAAQ,IAAI,GAAG,IAAI;AAAA,IACrB;AACA,YAAQ,IAAI,KAAK,KAAK;AACtB,WAAO;AAAA,EACT;AACF;AAWO,SAAS,gBAAmB,OAA6B;AAC9D,MAAI,iBAAiB,MAAM;AACzB,WAAO,MAAM,SAAS;AAAA,EACxB;AACA,SAAO;AACT;AAEO,SAAS,yBAAyB,MAAkB;AACzD,MAAI,KAAK,iBAAiB,GAAG;AAC3B,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AACF;",
+  "names": []
+}

package/dist/lib/path-class/index.js

@@ -2,7 +2,7 @@ import {
   Path,
   mustNotHaveTrailingSlash,
   stringifyIfPath
-} from "./chunks/chunk-VW3LCF27.js";
+} from "./chunks/chunk-DNNABIUU.js";
 export {
   Path,
   mustNotHaveTrailingSlash,

package/dist/lib/path-class/modifiedNodeTypes.d.ts

@@ -1,5 +1,5 @@
 import type { Abortable } from "node:events";
-import type { Dirent, ObjectEncodingOptions, OpenMode } from "node:fs";
+import type { BigIntStats, Dirent, ObjectEncodingOptions, OpenMode, StatOptions, Stats } from "node:fs";
 export declare function readDirType(options?: (ObjectEncodingOptions & {
     withFileTypes?: false | undefined;
     recursive?: boolean | undefined;
@@ -33,3 +33,21 @@ export declare function readFileType(options: ({
 export declare function readFileType(options?: (ObjectEncodingOptions & Abortable & {
     flag?: OpenMode | undefined;
 }) | BufferEncoding | null): Promise<string | Buffer>;
+export declare function lstatType(opts?: StatOptions & {
+    bigint?: false | undefined;
+}): Promise<Stats>;
+export declare function lstatType(opts: StatOptions & {
+    bigint: true;
+}): Promise<BigIntStats>;
+export declare function lstatType(opts?: StatOptions): Promise<Stats | BigIntStats>;
+/**
+ * @since v10.0.0
+ * @return Fulfills with the {fs.Stats} object for the given `path`.
+ */
+export declare function statType(opts?: StatOptions & {
+    bigint?: false | undefined;
+}): Promise<Stats>;
+export declare function statType(opts: StatOptions & {
+    bigint: true;
+}): Promise<BigIntStats>;
+export declare function statType(opts?: StatOptions): Promise<Stats | BigIntStats>;

package/dist/lib/path-class/sync/index.d.ts

@@ -1,6 +1,6 @@
-import { cpSync, lstatSync, mkdirSync, rmSync, statSync, symlinkSync, writeFileSync } from "node:fs";
+import { cpSync, mkdirSync, rmSync, symlinkSync, writeFileSync } from "node:fs";
 import "./static";
-import type { readDirSyncType, readFileSyncType } from "./modifiedNodeTypes";
+import type { lstatSyncType, readDirSyncType, readFileSyncType, statSyncType } from "./modifiedNodeTypes";
 declare module "../Path" {
     interface Path {
         existsSync(constraints?: {
@@ -21,7 +21,7 @@ declare module "../Path" {
         readDirSync: typeof readDirSyncType;
         /** Returns the destination path. */
         symlinkSync(target: string | URL | Path, type?: Parameters<typeof symlinkSync>[2]): Path;
-        statSync(options?: Parameters<typeof statSync>[1]): ReturnType<typeof statSync>;
-        lstatSync(options?: Parameters<typeof lstatSync>[1]): ReturnType<typeof lstatSync>;
+        statSync: typeof statSyncType;
+        lstatSync: typeof lstatSyncType;
     }
 }

package/dist/lib/path-class/sync/index.js

@@ -1,7 +1,7 @@
 import {
   Path,
   mustNotHaveTrailingSlash
-} from "../chunks/chunk-VW3LCF27.js";
+} from "../chunks/chunk-DNNABIUU.js";
 
 // src/sync/index.ts
 import {

package/dist/lib/path-class/sync/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../../src/sync/index.ts", "../../../../src/sync/static.ts"],
-  "sourcesContent": ["import {\n  cpSync,\n  lstatSync,\n  mkdirSync,\n  readdirSync,\n  readFileSync,\n  renameSync,\n  rmSync,\n  statSync,\n  symlinkSync,\n  writeFileSync,\n} from \"node:fs\";\nimport { mustNotHaveTrailingSlash, Path } from \"../Path\";\nimport \"./static\";\nimport type { readDirSyncType, readFileSyncType } from \"./modifiedNodeTypes\";\n\n// Note that (non-static) functions in this file are defined using `function(\u2026)\n// { \u2026 }` rather than arrow functions, specifically because we want `this` to\n// operate on the `Path` instance.\n\ndeclare module \"../Path\" {\n  interface Path {\n    existsSync(constraints?: { mustBe: \"file\" | \"directory\" }): boolean;\n    existsAsFileSync(): boolean;\n    existsAsDirSync(): boolean;\n\n    mkdirSync(options?: Parameters<typeof mkdirSync>[1]): Path;\n    cpSync(\n      destination: string | URL | Path,\n      options?: Parameters<typeof cpSync>[2],\n    ): Path;\n    renameSync(destination: string | URL | Path): void;\n\n    rmSync(options?: Parameters<typeof rmSync>[1]): void;\n    rm_rfSync(options?: Parameters<typeof rmSync>[1]): void;\n\n    readSync: typeof readFileSyncType;\n    readTextSync(): string;\n    readJSONSync<T>(): T;\n\n    writeSync(\n      data: Parameters<typeof writeFileSync>[1],\n      options?: Parameters<typeof writeFileSync>[2] | undefined,\n    ): Path;\n    writeJSONSync<T>(\n      data: T,\n      replacer?: Parameters<typeof JSON.stringify>[1],\n      space?: Parameters<typeof JSON.stringify>[2],\n    ): Path;\n\n    readDirSync: typeof readDirSyncType;\n\n    /** Returns the destination path. */\n    symlinkSync(\n      target: string | URL | Path,\n      type?: Parameters<typeof symlinkSync>[2],\n    ): Path;\n\n    statSync(\n      options?: Parameters<typeof statSync>[1],\n    ): ReturnType<typeof statSync>;\n\n    // I don't think `lstat` is a great name, but it does match the\n    // well-established canonical system call. So in this case we keep the\n    // awkward abbreviation.\n    lstatSync(\n      options?: Parameters<typeof lstatSync>[1],\n    ): ReturnType<typeof lstatSync>;\n  }\n}\n\n// TODO: find a neat way to dedup with the async version?\nPath.prototype.existsSync = function (constraints?: {\n  mustBe: \"file\" | \"directory\";\n}): boolean {\n  let stats: ReturnType<typeof statSync>;\n  try {\n    stats = statSync(this.path);\n    // biome-ignore lint/suspicious/noExplicitAny: TypeScript limitation\n  } catch (e: any) {\n    if (e.code === \"ENOENT\") {\n      return false;\n    }\n    throw e;\n  }\n  if (!constraints?.mustBe) {\n    return true;\n  }\n  switch (constraints?.mustBe) {\n    case \"file\": {\n      mustNotHaveTrailingSlash(this);\n      if (stats.isFile()) {\n        return true;\n      }\n      throw new Error(`Path exists but is not a file: ${this.path}`);\n    }\n    case \"directory\": {\n      if (stats.isDirectory()) {\n        return true;\n      }\n      throw new Error(`Path exists but is not a directory: ${this.path}`);\n    }\n    default: {\n      throw new Error(\"Invalid path type constraint\");\n    }\n  }\n};\n\nPath.prototype.existsAsFileSync = function (): boolean {\n  return this.existsSync({ mustBe: \"file\" });\n};\n\nPath.prototype.existsAsDirSync = function (): boolean {\n  return this.existsSync({ mustBe: \"directory\" });\n};\n\nPath.prototype.mkdirSync = function (\n  options?: Parameters<typeof mkdirSync>[1],\n): Path {\n  const optionsObject = (() => {\n    if (typeof options === \"string\" || typeof options === \"number\") {\n      return { mode: options };\n    }\n    return options ?? {};\n  })();\n  mkdirSync(this.path, { recursive: true, ...optionsObject });\n  return this;\n};\n\nPath.prototype.cpSync = function (\n  destination: string | URL | Path,\n  options?: Parameters<typeof cpSync>[2],\n): Path {\n  cpSync(this.path, new Path(destination).path, options);\n  return new Path(destination);\n};\n\nPath.prototype.renameSync = function (destination: string | URL | Path): void {\n  renameSync(this.path, new Path(destination).path);\n};\n\nPath.prototype.rmSync = function (\n  options?: Parameters<typeof rmSync>[1],\n): void {\n  rmSync(this.path, options);\n};\n\nPath.prototype.rm_rfSync = function (\n  options?: Parameters<typeof rmSync>[1],\n): void {\n  this.rmSync({ recursive: true, force: true, ...(options ?? {}) });\n};\n\nPath.prototype.readSync = function () {\n  /** @ts-expect-error ts(2683) */\n  return readFileSync(this.path);\n} as typeof readFileSyncType;\n\nPath.prototype.readTextSync = function (): string {\n  return readFileSync(this.path, \"utf-8\");\n};\n\nPath.prototype.readJSONSync = function <T>(): T {\n  return JSON.parse(this.readTextSync());\n};\n\nPath.prototype.writeSync = function (\n  data: Parameters<typeof writeFileSync>[1],\n  options?: Parameters<typeof writeFileSync>[2],\n): Path {\n  this.parent.mkdirSync();\n  writeFileSync(this.path, data, options);\n  return this;\n};\n\nPath.prototype.writeJSONSync = function <T>(\n  data: T,\n  replacer: Parameters<typeof JSON.stringify>[1] = null,\n  space: Parameters<typeof JSON.stringify>[2] = \"  \",\n): Path {\n  this.parent.mkdirSync();\n  this.writeSync(JSON.stringify(data, replacer, space));\n  return this;\n};\n\n/** @ts-expect-error ts(2322): Wrangle types */\nPath.prototype.readDirSync = function (options) {\n  // biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.\n  return readdirSync(this.path, options as any);\n};\n\nPath.prototype.symlinkSync = function symlink(\n  target: string | URL | Path,\n  type?: Parameters<typeof symlinkSync>[2],\n): Path {\n  const targetPath = new Path(target);\n  symlinkSync(\n    this.path,\n    targetPath.path,\n    type as Exclude<Parameters<typeof symlinkSync>[2], undefined>, // \uD83E\uDD37\n  );\n  return targetPath;\n};\n\nPath.prototype.statSync = function (\n  options?: Parameters<typeof statSync>[1],\n): ReturnType<typeof statSync> {\n  return statSync(this.path, options);\n};\n\nPath.prototype.lstatSync = function (\n  options?: Parameters<typeof lstatSync>[1],\n): ReturnType<typeof lstatSync> {\n  return lstatSync(this.path, options);\n};\n", "import { mkdtempSync } from \"node:fs\";\nimport { tmpdir } from \"node:os\";\nimport { Path } from \"../Path\";\n\ndeclare module \"../Path\" {\n  namespace Path {\n    export function makeTempDirSync(prefix?: string): Path;\n  }\n}\n\nPath.makeTempDirSync = (prefix?: string): Path =>\n  new Path(\n    mkdtempSync(new Path(tmpdir()).join(prefix ?? \"js-temp-\").toString()),\n  );\n"],
-  "mappings": ";;;;;;AAAA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;;;ACXP,SAAS,mBAAmB;AAC5B,SAAS,cAAc;AASvB,KAAK,kBAAkB,CAAC,WACtB,IAAI;AAAA,EACF,YAAY,IAAI,KAAK,OAAO,CAAC,EAAE,KAAK,UAAU,UAAU,EAAE,SAAS,CAAC;AACtE;;;AD2DF,KAAK,UAAU,aAAa,SAAU,aAE1B;AACV,MAAI;AACJ,MAAI;AACF,YAAQ,SAAS,KAAK,IAAI;AAAA,EAE5B,SAAS,GAAQ;AACf,QAAI,EAAE,SAAS,UAAU;AACvB,aAAO;AAAA,IACT;AACA,UAAM;AAAA,EACR;AACA,MAAI,CAAC,aAAa,QAAQ;AACxB,WAAO;AAAA,EACT;AACA,UAAQ,aAAa,QAAQ;AAAA,IAC3B,KAAK,QAAQ;AACX,+BAAyB,IAAI;AAC7B,UAAI,MAAM,OAAO,GAAG;AAClB,eAAO;AAAA,MACT;AACA,YAAM,IAAI,MAAM,kCAAkC,KAAK,IAAI,EAAE;AAAA,IAC/D;AAAA,IACA,KAAK,aAAa;AAChB,UAAI,MAAM,YAAY,GAAG;AACvB,eAAO;AAAA,MACT;AACA,YAAM,IAAI,MAAM,uCAAuC,KAAK,IAAI,EAAE;AAAA,IACpE;AAAA,IACA,SAAS;AACP,YAAM,IAAI,MAAM,8BAA8B;AAAA,IAChD;AAAA,EACF;AACF;AAEA,KAAK,UAAU,mBAAmB,WAAqB;AACrD,SAAO,KAAK,WAAW,EAAE,QAAQ,OAAO,CAAC;AAC3C;AAEA,KAAK,UAAU,kBAAkB,WAAqB;AACpD,SAAO,KAAK,WAAW,EAAE,QAAQ,YAAY,CAAC;AAChD;AAEA,KAAK,UAAU,YAAY,SACzB,SACM;AACN,QAAM,iBAAiB,MAAM;AAC3B,QAAI,OAAO,YAAY,YAAY,OAAO,YAAY,UAAU;AAC9D,aAAO,EAAE,MAAM,QAAQ;AAAA,IACzB;AACA,WAAO,WAAW,CAAC;AAAA,EACrB,GAAG;AACH,YAAU,KAAK,MAAM,EAAE,WAAW,MAAM,GAAG,cAAc,CAAC;AAC1D,SAAO;AACT;AAEA,KAAK,UAAU,SAAS,SACtB,aACA,SACM;AACN,SAAO,KAAK,MAAM,IAAI,KAAK,WAAW,EAAE,MAAM,OAAO;AACrD,SAAO,IAAI,KAAK,WAAW;AAC7B;AAEA,KAAK,UAAU,aAAa,SAAU,aAAwC;AAC5E,aAAW,KAAK,MAAM,IAAI,KAAK,WAAW,EAAE,IAAI;AAClD;AAEA,KAAK,UAAU,SAAS,SACtB,SACM;AACN,SAAO,KAAK,MAAM,OAAO;AAC3B;AAEA,KAAK,UAAU,YAAY,SACzB,SACM;AACN,OAAK,OAAO,EAAE,WAAW,MAAM,OAAO,MAAM,GAAI,WAAW,CAAC,EAAG,CAAC;AAClE;AAEA,KAAK,UAAU,WAAW,WAAY;AAEpC,SAAO,aAAa,KAAK,IAAI;AAC/B;AAEA,KAAK,UAAU,eAAe,WAAoB;AAChD,SAAO,aAAa,KAAK,MAAM,OAAO;AACxC;AAEA,KAAK,UAAU,eAAe,WAAkB;AAC9C,SAAO,KAAK,MAAM,KAAK,aAAa,CAAC;AACvC;AAEA,KAAK,UAAU,YAAY,SACzB,MACA,SACM;AACN,OAAK,OAAO,UAAU;AACtB,gBAAc,KAAK,MAAM,MAAM,OAAO;AACtC,SAAO;AACT;AAEA,KAAK,UAAU,gBAAgB,SAC7B,MACA,WAAiD,MACjD,QAA8C,MACxC;AACN,OAAK,OAAO,UAAU;AACtB,OAAK,UAAU,KAAK,UAAU,MAAM,UAAU,KAAK,CAAC;AACpD,SAAO;AACT;AAGA,KAAK,UAAU,cAAc,SAAU,SAAS;AAE9C,SAAO,YAAY,KAAK,MAAM,OAAc;AAC9C;AAEA,KAAK,UAAU,cAAc,SAAS,QACpC,QACA,MACM;AACN,QAAM,aAAa,IAAI,KAAK,MAAM;AAClC;AAAA,IACE,KAAK;AAAA,IACL,WAAW;AAAA,IACX;AAAA;AAAA,EACF;AACA,SAAO;AACT;AAEA,KAAK,UAAU,WAAW,SACxB,SAC6B;AAC7B,SAAO,SAAS,KAAK,MAAM,OAAO;AACpC;AAEA,KAAK,UAAU,YAAY,SACzB,SAC8B;AAC9B,SAAO,UAAU,KAAK,MAAM,OAAO;AACrC;",
+  "sourcesContent": ["import {\n  cpSync,\n  lstatSync,\n  mkdirSync,\n  readdirSync,\n  readFileSync,\n  renameSync,\n  rmSync,\n  statSync,\n  symlinkSync,\n  writeFileSync,\n} from \"node:fs\";\nimport { mustNotHaveTrailingSlash, Path } from \"../Path\";\nimport \"./static\";\nimport type {\n  lstatSyncType,\n  readDirSyncType,\n  readFileSyncType,\n  statSyncType,\n} from \"./modifiedNodeTypes\";\n\n// Note that (non-static) functions in this file are defined using `function(\u2026)\n// { \u2026 }` rather than arrow functions, specifically because we want `this` to\n// operate on the `Path` instance.\n\ndeclare module \"../Path\" {\n  interface Path {\n    existsSync(constraints?: { mustBe: \"file\" | \"directory\" }): boolean;\n    existsAsFileSync(): boolean;\n    existsAsDirSync(): boolean;\n\n    mkdirSync(options?: Parameters<typeof mkdirSync>[1]): Path;\n    cpSync(\n      destination: string | URL | Path,\n      options?: Parameters<typeof cpSync>[2],\n    ): Path;\n    renameSync(destination: string | URL | Path): void;\n\n    rmSync(options?: Parameters<typeof rmSync>[1]): void;\n    rm_rfSync(options?: Parameters<typeof rmSync>[1]): void;\n\n    readSync: typeof readFileSyncType;\n    readTextSync(): string;\n    readJSONSync<T>(): T;\n\n    writeSync(\n      data: Parameters<typeof writeFileSync>[1],\n      options?: Parameters<typeof writeFileSync>[2] | undefined,\n    ): Path;\n    writeJSONSync<T>(\n      data: T,\n      replacer?: Parameters<typeof JSON.stringify>[1],\n      space?: Parameters<typeof JSON.stringify>[2],\n    ): Path;\n\n    readDirSync: typeof readDirSyncType;\n\n    /** Returns the destination path. */\n    symlinkSync(\n      target: string | URL | Path,\n      type?: Parameters<typeof symlinkSync>[2],\n    ): Path;\n\n    statSync: typeof statSyncType;\n    lstatSync: typeof lstatSyncType;\n  }\n}\n\n// TODO: find a neat way to dedup with the async version?\nPath.prototype.existsSync = function (constraints?: {\n  mustBe: \"file\" | \"directory\";\n}): boolean {\n  let stats: ReturnType<typeof statSync>;\n  try {\n    stats = statSync(this.path);\n    // biome-ignore lint/suspicious/noExplicitAny: TypeScript limitation\n  } catch (e: any) {\n    if (e.code === \"ENOENT\") {\n      return false;\n    }\n    throw e;\n  }\n  if (!constraints?.mustBe) {\n    return true;\n  }\n  switch (constraints?.mustBe) {\n    case \"file\": {\n      mustNotHaveTrailingSlash(this);\n      if (stats.isFile()) {\n        return true;\n      }\n      throw new Error(`Path exists but is not a file: ${this.path}`);\n    }\n    case \"directory\": {\n      if (stats.isDirectory()) {\n        return true;\n      }\n      throw new Error(`Path exists but is not a directory: ${this.path}`);\n    }\n    default: {\n      throw new Error(\"Invalid path type constraint\");\n    }\n  }\n};\n\nPath.prototype.existsAsFileSync = function (): boolean {\n  return this.existsSync({ mustBe: \"file\" });\n};\n\nPath.prototype.existsAsDirSync = function (): boolean {\n  return this.existsSync({ mustBe: \"directory\" });\n};\n\nPath.prototype.mkdirSync = function (\n  options?: Parameters<typeof mkdirSync>[1],\n): Path {\n  const optionsObject = (() => {\n    if (typeof options === \"string\" || typeof options === \"number\") {\n      return { mode: options };\n    }\n    return options ?? {};\n  })();\n  mkdirSync(this.path, { recursive: true, ...optionsObject });\n  return this;\n};\n\nPath.prototype.cpSync = function (\n  destination: string | URL | Path,\n  options?: Parameters<typeof cpSync>[2],\n): Path {\n  cpSync(this.path, new Path(destination).path, options);\n  return new Path(destination);\n};\n\nPath.prototype.renameSync = function (destination: string | URL | Path): void {\n  renameSync(this.path, new Path(destination).path);\n};\n\nPath.prototype.rmSync = function (\n  options?: Parameters<typeof rmSync>[1],\n): void {\n  rmSync(this.path, options);\n};\n\nPath.prototype.rm_rfSync = function (\n  options?: Parameters<typeof rmSync>[1],\n): void {\n  this.rmSync({ recursive: true, force: true, ...(options ?? {}) });\n};\n\nPath.prototype.readSync = function () {\n  /** @ts-expect-error ts(2683) */\n  return readFileSync(this.path);\n} as typeof readFileSyncType;\n\nPath.prototype.readTextSync = function (): string {\n  return readFileSync(this.path, \"utf-8\");\n};\n\nPath.prototype.readJSONSync = function <T>(): T {\n  return JSON.parse(this.readTextSync());\n};\n\nPath.prototype.writeSync = function (\n  data: Parameters<typeof writeFileSync>[1],\n  options?: Parameters<typeof writeFileSync>[2],\n): Path {\n  this.parent.mkdirSync();\n  writeFileSync(this.path, data, options);\n  return this;\n};\n\nPath.prototype.writeJSONSync = function <T>(\n  data: T,\n  replacer: Parameters<typeof JSON.stringify>[1] = null,\n  space: Parameters<typeof JSON.stringify>[2] = \"  \",\n): Path {\n  this.parent.mkdirSync();\n  this.writeSync(JSON.stringify(data, replacer, space));\n  return this;\n};\n\n/** @ts-expect-error ts(2322): Wrangle types */\nPath.prototype.readDirSync = function (options) {\n  // biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.\n  return readdirSync(this.path, options as any);\n};\n\nPath.prototype.symlinkSync = function symlink(\n  target: string | URL | Path,\n  type?: Parameters<typeof symlinkSync>[2],\n): Path {\n  const targetPath = new Path(target);\n  symlinkSync(\n    this.path,\n    targetPath.path,\n    type as Exclude<Parameters<typeof symlinkSync>[2], undefined>, // \uD83E\uDD37\n  );\n  return targetPath;\n};\n\n/** @ts-expect-error ts(2322): Wrangle types */\nPath.prototype.statSync = function (\n  options?: Parameters<typeof statSync>[1],\n): ReturnType<typeof statSync> {\n  return statSync(this.path, options);\n};\n\n/** @ts-expect-error ts(2322): Wrangle types */\nPath.prototype.lstatSync = function (\n  options?: Parameters<typeof lstatSync>[1],\n): ReturnType<typeof lstatSync> {\n  return lstatSync(this.path, options);\n};\n", "import { mkdtempSync } from \"node:fs\";\nimport { tmpdir } from \"node:os\";\nimport { Path } from \"../Path\";\n\ndeclare module \"../Path\" {\n  namespace Path {\n    export function makeTempDirSync(prefix?: string): Path;\n  }\n}\n\nPath.makeTempDirSync = (prefix?: string): Path =>\n  new Path(\n    mkdtempSync(new Path(tmpdir()).join(prefix ?? \"js-temp-\").toString()),\n  );\n"],
+  "mappings": ";;;;;;AAAA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;;;ACXP,SAAS,mBAAmB;AAC5B,SAAS,cAAc;AASvB,KAAK,kBAAkB,CAAC,WACtB,IAAI;AAAA,EACF,YAAY,IAAI,KAAK,OAAO,CAAC,EAAE,KAAK,UAAU,UAAU,EAAE,SAAS,CAAC;AACtE;;;ADwDF,KAAK,UAAU,aAAa,SAAU,aAE1B;AACV,MAAI;AACJ,MAAI;AACF,YAAQ,SAAS,KAAK,IAAI;AAAA,EAE5B,SAAS,GAAQ;AACf,QAAI,EAAE,SAAS,UAAU;AACvB,aAAO;AAAA,IACT;AACA,UAAM;AAAA,EACR;AACA,MAAI,CAAC,aAAa,QAAQ;AACxB,WAAO;AAAA,EACT;AACA,UAAQ,aAAa,QAAQ;AAAA,IAC3B,KAAK,QAAQ;AACX,+BAAyB,IAAI;AAC7B,UAAI,MAAM,OAAO,GAAG;AAClB,eAAO;AAAA,MACT;AACA,YAAM,IAAI,MAAM,kCAAkC,KAAK,IAAI,EAAE;AAAA,IAC/D;AAAA,IACA,KAAK,aAAa;AAChB,UAAI,MAAM,YAAY,GAAG;AACvB,eAAO;AAAA,MACT;AACA,YAAM,IAAI,MAAM,uCAAuC,KAAK,IAAI,EAAE;AAAA,IACpE;AAAA,IACA,SAAS;AACP,YAAM,IAAI,MAAM,8BAA8B;AAAA,IAChD;AAAA,EACF;AACF;AAEA,KAAK,UAAU,mBAAmB,WAAqB;AACrD,SAAO,KAAK,WAAW,EAAE,QAAQ,OAAO,CAAC;AAC3C;AAEA,KAAK,UAAU,kBAAkB,WAAqB;AACpD,SAAO,KAAK,WAAW,EAAE,QAAQ,YAAY,CAAC;AAChD;AAEA,KAAK,UAAU,YAAY,SACzB,SACM;AACN,QAAM,iBAAiB,MAAM;AAC3B,QAAI,OAAO,YAAY,YAAY,OAAO,YAAY,UAAU;AAC9D,aAAO,EAAE,MAAM,QAAQ;AAAA,IACzB;AACA,WAAO,WAAW,CAAC;AAAA,EACrB,GAAG;AACH,YAAU,KAAK,MAAM,EAAE,WAAW,MAAM,GAAG,cAAc,CAAC;AAC1D,SAAO;AACT;AAEA,KAAK,UAAU,SAAS,SACtB,aACA,SACM;AACN,SAAO,KAAK,MAAM,IAAI,KAAK,WAAW,EAAE,MAAM,OAAO;AACrD,SAAO,IAAI,KAAK,WAAW;AAC7B;AAEA,KAAK,UAAU,aAAa,SAAU,aAAwC;AAC5E,aAAW,KAAK,MAAM,IAAI,KAAK,WAAW,EAAE,IAAI;AAClD;AAEA,KAAK,UAAU,SAAS,SACtB,SACM;AACN,SAAO,KAAK,MAAM,OAAO;AAC3B;AAEA,KAAK,UAAU,YAAY,SACzB,SACM;AACN,OAAK,OAAO,EAAE,WAAW,MAAM,OAAO,MAAM,GAAI,WAAW,CAAC,EAAG,CAAC;AAClE;AAEA,KAAK,UAAU,WAAW,WAAY;AAEpC,SAAO,aAAa,KAAK,IAAI;AAC/B;AAEA,KAAK,UAAU,eAAe,WAAoB;AAChD,SAAO,aAAa,KAAK,MAAM,OAAO;AACxC;AAEA,KAAK,UAAU,eAAe,WAAkB;AAC9C,SAAO,KAAK,MAAM,KAAK,aAAa,CAAC;AACvC;AAEA,KAAK,UAAU,YAAY,SACzB,MACA,SACM;AACN,OAAK,OAAO,UAAU;AACtB,gBAAc,KAAK,MAAM,MAAM,OAAO;AACtC,SAAO;AACT;AAEA,KAAK,UAAU,gBAAgB,SAC7B,MACA,WAAiD,MACjD,QAA8C,MACxC;AACN,OAAK,OAAO,UAAU;AACtB,OAAK,UAAU,KAAK,UAAU,MAAM,UAAU,KAAK,CAAC;AACpD,SAAO;AACT;AAGA,KAAK,UAAU,cAAc,SAAU,SAAS;AAE9C,SAAO,YAAY,KAAK,MAAM,OAAc;AAC9C;AAEA,KAAK,UAAU,cAAc,SAAS,QACpC,QACA,MACM;AACN,QAAM,aAAa,IAAI,KAAK,MAAM;AAClC;AAAA,IACE,KAAK;AAAA,IACL,WAAW;AAAA,IACX;AAAA;AAAA,EACF;AACA,SAAO;AACT;AAGA,KAAK,UAAU,WAAW,SACxB,SAC6B;AAC7B,SAAO,SAAS,KAAK,MAAM,OAAO;AACpC;AAGA,KAAK,UAAU,YAAY,SACzB,SAC8B;AAC9B,SAAO,UAAU,KAAK,MAAM,OAAO;AACrC;",
   "names": []
 }

package/dist/lib/path-class/sync/modifiedNodeTypes.d.ts

@@ -1,4 +1,4 @@
-import type { Dirent, ObjectEncodingOptions } from "node:fs";
+import type { BigIntStats, Dirent, ObjectEncodingOptions, StatSyncOptions, Stats } from "node:fs";
 export declare function readFileSyncType(options?: {
     encoding?: null | undefined;
     flag?: string | undefined;
@@ -33,3 +33,24 @@ export declare function readDirSyncType(options: {
     withFileTypes: true;
     recursive?: boolean | undefined;
 }): Dirent<Buffer>[];
+export declare function statSyncType(options?: undefined): Stats;
+export declare function statSyncType(options?: StatSyncOptions & {
+    bigint?: false | undefined;
+    throwIfNoEntry: false;
+}): Stats | undefined;
+export declare function statSyncType(options: StatSyncOptions & {
+    bigint: true;
+    throwIfNoEntry: false;
+}): BigIntStats | undefined;
+export declare function statSyncType(options?: StatSyncOptions & {
+    bigint?: false | undefined;
+}): Stats;
+export declare function statSyncType(options: StatSyncOptions & {
+    bigint: true;
+}): BigIntStats;
+export declare function statSyncType(options: StatSyncOptions & {
+    bigint: boolean;
+    throwIfNoEntry?: false | undefined;
+}): Stats | BigIntStats;
+export declare function statSyncType(options?: StatSyncOptions): Stats | BigIntStats | undefined;
+export declare const lstatSyncType: typeof statSyncType;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "path-class",
-  "version": "0.7.1",
+  "version": "0.7.2",
   "author": "Lucas Garron <code@garron.net>",
   "type": "module",
   "main": "./dist/lib/path-class/index.js",

package/src/Path.ts

@@ -21,7 +21,16 @@ import {
   xdgRuntime,
   xdgState,
 } from "xdg-basedir";
-import type { readDirType, readFileType } from "./modifiedNodeTypes";
+import type {
+  lstatType,
+  readDirType,
+  readFileType,
+  statType,
+} from "./modifiedNodeTypes";
+
+// Note that (non-static) functions in this file are defined using `function(…)
+// { … }` rather than arrow functions, specifically because we want `this` to
+// operate on the `Path` instance.
 
 export class Path {
   // @ts-expect-error ts(2564): False positive. https://github.com/microsoft/TypeScript/issues/32194
@@ -325,16 +334,15 @@ export class Path {
     return targetPath;
   }
 
-  stat(options?: Parameters<typeof stat>[1]): ReturnType<typeof stat> {
-    return stat(this.path, options);
-  }
+  // biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.
+  stat: typeof statType = (...options) => stat(this.#path, ...options) as any;
 
   // I don't think `lstat` is a great name, but it does match the
   // well-established canonical system call. So in this case we keep the
   // awkward abbreviation.
-  lstat(options?: Parameters<typeof lstat>[1]): ReturnType<typeof lstat> {
-    return lstat(this.path, options);
-  }
+  lstat: typeof lstatType = (...options) =>
+    // biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.
+    lstat(this.#path, ...options) as any;
 
   static get homedir(): Path {
     return new Path(homedir());

package/src/modifiedNodeTypes.ts

@@ -1,7 +1,14 @@
 // Note: this file is `.ts` rather than `.d.ts` to ensure it ends up in the `tsc` output.
 
 import type { Abortable } from "node:events";
-import type { Dirent, ObjectEncodingOptions, OpenMode } from "node:fs";
+import type {
+  BigIntStats,
+  Dirent,
+  ObjectEncodingOptions,
+  OpenMode,
+  StatOptions,
+  Stats,
+} from "node:fs";
 
 // Modifying the type of `readdir(…)` from `node:fs/promises` to remove the
 // first parameter is difficult, if not impossible. So we give up and duplicate
@@ -76,3 +83,34 @@ export declare function readFileType(
     | BufferEncoding
     | null,
 ): Promise<string | Buffer>;
+
+export declare function lstatType(
+  opts?: StatOptions & {
+    bigint?: false | undefined;
+  },
+): Promise<Stats>;
+export declare function lstatType(
+  opts: StatOptions & {
+    bigint: true;
+  },
+): Promise<BigIntStats>;
+export declare function lstatType(
+  opts?: StatOptions,
+): Promise<Stats | BigIntStats>;
+/**
+ * @since v10.0.0
+ * @return Fulfills with the {fs.Stats} object for the given `path`.
+ */
+export declare function statType(
+  opts?: StatOptions & {
+    bigint?: false | undefined;
+  },
+): Promise<Stats>;
+export declare function statType(
+  opts: StatOptions & {
+    bigint: true;
+  },
+): Promise<BigIntStats>;
+export declare function statType(
+  opts?: StatOptions,
+): Promise<Stats | BigIntStats>;

package/src/sync/index.ts

@@ -12,7 +12,12 @@ import {
 } from "node:fs";
 import { mustNotHaveTrailingSlash, Path } from "../Path";
 import "./static";
-import type { readDirSyncType, readFileSyncType } from "./modifiedNodeTypes";
+import type {
+  lstatSyncType,
+  readDirSyncType,
+  readFileSyncType,
+  statSyncType,
+} from "./modifiedNodeTypes";
 
 // Note that (non-static) functions in this file are defined using `function(…)
 // { … }` rather than arrow functions, specifically because we want `this` to
@@ -56,16 +61,8 @@ declare module "../Path" {
       type?: Parameters<typeof symlinkSync>[2],
     ): Path;
 
-    statSync(
-      options?: Parameters<typeof statSync>[1],
-    ): ReturnType<typeof statSync>;
-
-    // I don't think `lstat` is a great name, but it does match the
-    // well-established canonical system call. So in this case we keep the
-    // awkward abbreviation.
-    lstatSync(
-      options?: Parameters<typeof lstatSync>[1],
-    ): ReturnType<typeof lstatSync>;
+    statSync: typeof statSyncType;
+    lstatSync: typeof lstatSyncType;
   }
 }
 
@@ -202,12 +199,14 @@ Path.prototype.symlinkSync = function symlink(
   return targetPath;
 };
 
+/** @ts-expect-error ts(2322): Wrangle types */
 Path.prototype.statSync = function (
   options?: Parameters<typeof statSync>[1],
 ): ReturnType<typeof statSync> {
   return statSync(this.path, options);
 };
 
+/** @ts-expect-error ts(2322): Wrangle types */
 Path.prototype.lstatSync = function (
   options?: Parameters<typeof lstatSync>[1],
 ): ReturnType<typeof lstatSync> {

package/src/sync/modifiedNodeTypes.ts

@@ -1,6 +1,12 @@
 // Note: this file is `.ts` rather than `.d.ts` to ensure it ends up in the `tsc` output.
 
-import type { Dirent, ObjectEncodingOptions } from "node:fs";
+import type {
+  BigIntStats,
+  Dirent,
+  ObjectEncodingOptions,
+  StatSyncOptions,
+  Stats,
+} from "node:fs";
 
 export declare function readFileSyncType(
   options?: {
@@ -64,3 +70,38 @@ export declare function readDirSyncType(options: {
   withFileTypes: true;
   recursive?: boolean | undefined;
 }): Dirent<Buffer>[];
+
+export declare function statSyncType(options?: undefined): Stats;
+export declare function statSyncType(
+  options?: StatSyncOptions & {
+    bigint?: false | undefined;
+    throwIfNoEntry: false;
+  },
+): Stats | undefined;
+export declare function statSyncType(
+  options: StatSyncOptions & {
+    bigint: true;
+    throwIfNoEntry: false;
+  },
+): BigIntStats | undefined;
+export declare function statSyncType(
+  options?: StatSyncOptions & {
+    bigint?: false | undefined;
+  },
+): Stats;
+export declare function statSyncType(
+  options: StatSyncOptions & {
+    bigint: true;
+  },
+): BigIntStats;
+export declare function statSyncType(
+  options: StatSyncOptions & {
+    bigint: boolean;
+    throwIfNoEntry?: false | undefined;
+  },
+): Stats | BigIntStats;
+export declare function statSyncType(
+  options?: StatSyncOptions,
+): Stats | BigIntStats | undefined;
+
+export declare const lstatSyncType: typeof statSyncType;

package/dist/lib/path-class/chunks/chunk-VW3LCF27.js.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../../src/Path.ts"],
-  "sourcesContent": ["import {\n  cp,\n  lstat,\n  mkdir,\n  mkdtemp,\n  readdir,\n  readFile,\n  rename,\n  rm,\n  stat,\n  symlink,\n  writeFile,\n} from \"node:fs/promises\";\nimport { homedir, tmpdir } from \"node:os\";\nimport { basename, dirname, extname, join } from \"node:path\";\nimport { fileURLToPath, pathToFileURL } from \"node:url\";\nimport {\n  xdgCache,\n  xdgConfig,\n  xdgData,\n  xdgRuntime,\n  xdgState,\n} from \"xdg-basedir\";\nimport type { readDirType, readFileType } from \"./modifiedNodeTypes\";\n\nexport class Path {\n  // @ts-expect-error ts(2564): False positive. https://github.com/microsoft/TypeScript/issues/32194\n  #path: string;\n  /**\n   * If `path` is a string starting with `file:///`, it will be parsed as a file URL.\n   */\n  constructor(path: string | URL | Path) {\n    this.#setNormalizedPath(Path.#pathlikeToString(path));\n  }\n\n  /**\n   * Similar to `new URL(path, base)`, but accepting and returning `Path` objects.\n   * Note that `base` must be one of:\n   *\n   * - a valid second argument to `new URL(\u2026)`.\n   * - a `Path` representing an absolute path.\n   *\n   */\n  static resolve(path: string | URL | Path, base: string | URL | Path): Path {\n    const baseURL = (() => {\n      if (!(base instanceof Path)) {\n        return base;\n      }\n      if (!base.isAbsolutePath()) {\n        throw new Error(\n          \"The `base` arg to `Path.resolve(\u2026)` must be an absolute path.\",\n        );\n      }\n      return pathToFileURL(base.#path);\n    })();\n    return new Path(new URL(Path.#pathlikeToString(path), baseURL));\n  }\n\n  static #pathlikeToString(path: string | URL | Path): string {\n    if (path instanceof Path) {\n      return path.#path;\n    }\n    if (path instanceof URL) {\n      return fileURLToPath(path);\n    }\n    if (typeof path === \"string\") {\n      // TODO: allow turning off this heuristic?\n      if (path.startsWith(\"file:///\")) {\n        return fileURLToPath(path);\n      }\n      return path;\n    }\n    throw new Error(\"Invalid path\");\n  }\n\n  #setNormalizedPath(path: string): void {\n    this.#path = join(path);\n  }\n\n  isAbsolutePath(): boolean {\n    return this.#path.startsWith(\"/\");\n  }\n\n  toFileURL(): URL {\n    if (!this.isAbsolutePath()) {\n      throw new Error(\n        \"Tried to convert to file URL when the path is not absolute.\",\n      );\n    }\n    return pathToFileURL(this.#path);\n  }\n\n  /**\n   * The `Path` can have a trailing slash, indicating that it represents a\n   * directory. (If there is no trailing slash, it can represent either a file\n   * or a directory.)\n   *\n   * Some operations will refuse to treat a directory path as a file path. This\n   * function identifies such paths.\n   */\n  hasTrailingSlash(): boolean {\n    // TODO: handle Windows semantically\n    return this.#path.endsWith(\"/\");\n  }\n\n  /**\n   * Same as `.toString()`, but more concise.\n   */\n  get path() {\n    return this.#path;\n  }\n\n  toString(): string {\n    return this.#path;\n  }\n\n  /** Constructs a new path by appending the given path segments.\n   * This follows `node` semantics for absolute paths: leading slashes in the given descendant segments are ignored.\n   */\n  join(...segments: (string | Path)[]): Path {\n    const segmentStrings = segments.map((segment) =>\n      segment instanceof Path ? segment.path : segment,\n    );\n    return new Path(join(this.#path, ...segmentStrings));\n  }\n\n  extendBasename(suffix: string): Path {\n    const joinedSuffix = join(suffix);\n    if (joinedSuffix !== basename(joinedSuffix)) {\n      throw new Error(\"Invalid suffix to extend file name.\");\n    }\n    // TODO: join basename and dirname instead?\n    return new Path(this.#path + joinedSuffix);\n  }\n\n  get parent(): Path {\n    return new Path(dirname(this.#path));\n  }\n\n  // Normally I'd stick with `node`'s name, but I think `.dirname` is a\n  // particularly poor name. So we support `.dirname` for discovery but mark it\n  // as deprecated, even if it will never be removed.\n  /** @deprecated Alias for `.parent`. */\n  get dirname(): Path {\n    return this.parent;\n  }\n\n  get basename(): Path {\n    return new Path(basename(this.#path));\n  }\n\n  get extension(): string {\n    mustNotHaveTrailingSlash(this);\n    return extname(this.#path);\n  }\n\n  // Normally I'd stick with `node`'s name, but I think `.extname` is a\n  // particularly poor name. So we support `.extname` for discovery but mark it\n  // as deprecated, even if it will never be removed.\n  /** @deprecated Alias for `.extension`. */\n  get extname(): string {\n    return this.extension;\n  }\n\n  // TODO: find a neat way to dedup with the sync version?\n  async exists(constraints?: {\n    mustBe: \"file\" | \"directory\";\n  }): Promise<boolean> {\n    let stats: Awaited<ReturnType<typeof stat>>;\n    try {\n      stats = await stat(this.#path);\n      // biome-ignore lint/suspicious/noExplicitAny: TypeScript limitation\n    } catch (e: any) {\n      if (e.code === \"ENOENT\") {\n        return false;\n      }\n      throw e;\n    }\n    if (!constraints?.mustBe) {\n      return true;\n    }\n    switch (constraints?.mustBe) {\n      case \"file\": {\n        mustNotHaveTrailingSlash(this);\n        if (stats.isFile()) {\n          return true;\n        }\n        throw new Error(`Path exists but is not a file: ${this.#path}`);\n      }\n      case \"directory\": {\n        if (stats.isDirectory()) {\n          return true;\n        }\n        throw new Error(`Path exists but is not a directory: ${this.#path}`);\n      }\n      default: {\n        throw new Error(\"Invalid path type constraint\");\n      }\n    }\n  }\n\n  async existsAsFile(): Promise<boolean> {\n    return this.exists({ mustBe: \"file\" });\n  }\n\n  async existsAsDir(): Promise<boolean> {\n    return this.exists({ mustBe: \"directory\" });\n  }\n\n  // I don't think `mkdir` is a great name, but it does match the\n  // well-established canonical commandline name. So in this case we keep the\n  // awkward abbreviation.\n  /** Defaults to `recursive: true`. */\n  async mkdir(options?: Parameters<typeof mkdir>[1]): Promise<Path> {\n    const optionsObject = (() => {\n      if (typeof options === \"string\" || typeof options === \"number\") {\n        return { mode: options };\n      }\n      return options ?? {};\n    })();\n    await mkdir(this.#path, { recursive: true, ...optionsObject });\n    return this;\n  }\n\n  // TODO: check idempotency semantics when the destination exists and is a folder.\n  /** Returns the destination path. */\n  async cp(\n    destination: string | URL | Path,\n    options?: Parameters<typeof cp>[2],\n  ): Promise<Path> {\n    await cp(this.#path, new Path(destination).#path, options);\n    return new Path(destination);\n  }\n\n  // TODO: check idempotency semantics when the destination exists and is a folder.\n  async rename(destination: string | URL | Path): Promise<void> {\n    await rename(this.#path, new Path(destination).#path);\n  }\n\n  /** Create a temporary dir inside the global temp dir for the current user. */\n  static async makeTempDir(prefix?: string): Promise<Path> {\n    return new Path(\n      await mkdtemp(new Path(tmpdir()).join(prefix ?? \"js-temp-\").toString()),\n    );\n  }\n\n  async rm(options?: Parameters<typeof rm>[1]): Promise<void> {\n    await rm(this.#path, options);\n  }\n\n  /**\n   * Equivalent to:\n   *\n   *     .rm({ recursive: true, force: true, ...(options ?? {}) })\n   *\n   */\n  async rm_rf(options?: Parameters<typeof rm>[1]): Promise<void> {\n    await this.rm({ recursive: true, force: true, ...(options ?? {}) });\n  }\n\n  read: typeof readFileType = (options) =>\n    // biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.\n    readFile(this.#path, options as any) as any;\n\n  async readText(): Promise<string> {\n    return readFile(this.#path, \"utf-8\");\n  }\n\n  async readJSON<T>(): Promise<T> {\n    return JSON.parse(await this.readText());\n  }\n\n  /** Creates intermediate directories if they do not exist.\n   *\n   * Returns the original `Path` (for chaining).\n   */\n  async write(\n    data: Parameters<typeof writeFile>[1],\n    options?: Parameters<typeof writeFile>[2],\n  ): Promise<Path> {\n    await this.parent.mkdir();\n    await writeFile(this.#path, data, options);\n    return this;\n  }\n\n  /**\n   * If only `data` is provided, this is equivalent to:\n   *\n   *     .write(JSON.stringify(data, null, \"  \"));\n   *\n   * `replacer` and `space` can also be specified, making this equivalent to:\n   *\n   *     .write(JSON.stringify(data, replacer, space));\n   *\n   * Returns the original `Path` (for chaining).\n   */\n  async writeJSON<T>(\n    data: T,\n    replacer: Parameters<typeof JSON.stringify>[1] = null,\n    space: Parameters<typeof JSON.stringify>[2] = \"  \",\n  ): Promise<Path> {\n    await this.write(JSON.stringify(data, replacer, space));\n    return this;\n  }\n\n  // Normally we'd add a `@deprecated` alias named `.readdir`, but that would\n  // differ only by capitalization of a single non-leading character. This can\n  // be a bit confusing, especially when autocompleting. So for this function in\n  // particular we don't include an alias.\n  readDir: typeof readDirType = (options) =>\n    // biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.\n    readdir(this.#path, options as any) as any;\n\n  /** Returns the destination path. */\n  async symlink(\n    target: string | URL | Path,\n    type?: Parameters<typeof symlink>[2],\n  ): Promise<Path> {\n    const targetPath = new Path(target);\n    await symlink(\n      this.path,\n      targetPath.path,\n      type as Exclude<Parameters<typeof symlink>[2], undefined>, // \uD83E\uDD37\n    );\n    return targetPath;\n  }\n\n  stat(options?: Parameters<typeof stat>[1]): ReturnType<typeof stat> {\n    return stat(this.path, options);\n  }\n\n  // I don't think `lstat` is a great name, but it does match the\n  // well-established canonical system call. So in this case we keep the\n  // awkward abbreviation.\n  lstat(options?: Parameters<typeof lstat>[1]): ReturnType<typeof lstat> {\n    return lstat(this.path, options);\n  }\n\n  static get homedir(): Path {\n    return new Path(homedir());\n  }\n\n  static xdg = {\n    cache: new Path(xdgCache ?? Path.homedir.join(\".cache\")),\n    config: new Path(xdgConfig ?? Path.homedir.join(\".config\")),\n    data: new Path(xdgData ?? Path.homedir.join(\".local/share\")),\n    state: new Path(xdgState ?? Path.homedir.join(\".local/state\")),\n    /**\n     * {@link Path.xdg.runtime} does not have a default value. Consider\n     * {@link Path.xdg.runtimeWithStateFallback} if you need a fallback but do not have a particular fallback in mind.\n     */\n    runtime: xdgRuntime ? new Path(xdgRuntime) : undefined,\n    runtimeWithStateFallback: xdgRuntime\n      ? new Path(xdgRuntime)\n      : new Path(xdgState ?? Path.homedir.join(\".local/state\")),\n  };\n\n  /** Chainable function to print the path. Prints the same as:\n   *\n   *     if (args.length > 0) {\n   *      console.log(...args);\n   *     }\n   *     console.log(this.path);\n   *\n   */\n  // biome-ignore lint/suspicious/noExplicitAny: This is the correct type, based on `console.log(\u2026)`.\n  debugPrint(...args: any[]): Path {\n    if (args.length > 0) {\n      console.log(...args);\n    }\n    console.log(this.#path);\n    return this;\n  }\n}\n\n/**\n * This function is useful to serialize any `Path`s in a structure to pass on to\n * functions that do not know about the `Path` class, e.g.\n *\n *     function process(args: (string | Path)[]) {\n *       const argsAsStrings = args.map(stringifyIfPath);\n *     }\n *\n */\nexport function stringifyIfPath<T>(value: T | Path): T | string {\n  if (value instanceof Path) {\n    return value.toString();\n  }\n  return value;\n}\n\nexport function mustNotHaveTrailingSlash(path: Path): void {\n  if (path.hasTrailingSlash()) {\n    throw new Error(\n      \"Path ends with a slash, which cannot be treated as a file.\",\n    );\n  }\n}\n"],
-  "mappings": ";AAAA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,SAAS,cAAc;AAChC,SAAS,UAAU,SAAS,SAAS,YAAY;AACjD,SAAS,eAAe,qBAAqB;AAC7C;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAGA,IAAM,OAAN,MAAM,MAAK;AAAA;AAAA,EAEhB;AAAA;AAAA;AAAA;AAAA,EAIA,YAAY,MAA2B;AACrC,SAAK,mBAAmB,MAAK,kBAAkB,IAAI,CAAC;AAAA,EACtD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,OAAO,QAAQ,MAA2B,MAAiC;AACzE,UAAM,WAAW,MAAM;AACrB,UAAI,EAAE,gBAAgB,QAAO;AAC3B,eAAO;AAAA,MACT;AACA,UAAI,CAAC,KAAK,eAAe,GAAG;AAC1B,cAAM,IAAI;AAAA,UACR;AAAA,QACF;AAAA,MACF;AACA,aAAO,cAAc,KAAK,KAAK;AAAA,IACjC,GAAG;AACH,WAAO,IAAI,MAAK,IAAI,IAAI,MAAK,kBAAkB,IAAI,GAAG,OAAO,CAAC;AAAA,EAChE;AAAA,EAEA,OAAO,kBAAkB,MAAmC;AAC1D,QAAI,gBAAgB,OAAM;AACxB,aAAO,KAAK;AAAA,IACd;AACA,QAAI,gBAAgB,KAAK;AACvB,aAAO,cAAc,IAAI;AAAA,IAC3B;AACA,QAAI,OAAO,SAAS,UAAU;AAE5B,UAAI,KAAK,WAAW,UAAU,GAAG;AAC/B,eAAO,cAAc,IAAI;AAAA,MAC3B;AACA,aAAO;AAAA,IACT;AACA,UAAM,IAAI,MAAM,cAAc;AAAA,EAChC;AAAA,EAEA,mBAAmB,MAAoB;AACrC,SAAK,QAAQ,KAAK,IAAI;AAAA,EACxB;AAAA,EAEA,iBAA0B;AACxB,WAAO,KAAK,MAAM,WAAW,GAAG;AAAA,EAClC;AAAA,EAEA,YAAiB;AACf,QAAI,CAAC,KAAK,eAAe,GAAG;AAC1B,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AACA,WAAO,cAAc,KAAK,KAAK;AAAA,EACjC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,mBAA4B;AAE1B,WAAO,KAAK,MAAM,SAAS,GAAG;AAAA,EAChC;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,OAAO;AACT,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,WAAmB;AACjB,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA,EAKA,QAAQ,UAAmC;AACzC,UAAM,iBAAiB,SAAS;AAAA,MAAI,CAAC,YACnC,mBAAmB,QAAO,QAAQ,OAAO;AAAA,IAC3C;AACA,WAAO,IAAI,MAAK,KAAK,KAAK,OAAO,GAAG,cAAc,CAAC;AAAA,EACrD;AAAA,EAEA,eAAe,QAAsB;AACnC,UAAM,eAAe,KAAK,MAAM;AAChC,QAAI,iBAAiB,SAAS,YAAY,GAAG;AAC3C,YAAM,IAAI,MAAM,qCAAqC;AAAA,IACvD;AAEA,WAAO,IAAI,MAAK,KAAK,QAAQ,YAAY;AAAA,EAC3C;AAAA,EAEA,IAAI,SAAe;AACjB,WAAO,IAAI,MAAK,QAAQ,KAAK,KAAK,CAAC;AAAA,EACrC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAI,UAAgB;AAClB,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAI,WAAiB;AACnB,WAAO,IAAI,MAAK,SAAS,KAAK,KAAK,CAAC;AAAA,EACtC;AAAA,EAEA,IAAI,YAAoB;AACtB,6BAAyB,IAAI;AAC7B,WAAO,QAAQ,KAAK,KAAK;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAI,UAAkB;AACpB,WAAO,KAAK;AAAA,EACd;AAAA;AAAA,EAGA,MAAM,OAAO,aAEQ;AACnB,QAAI;AACJ,QAAI;AACF,cAAQ,MAAM,KAAK,KAAK,KAAK;AAAA,IAE/B,SAAS,GAAQ;AACf,UAAI,EAAE,SAAS,UAAU;AACvB,eAAO;AAAA,MACT;AACA,YAAM;AAAA,IACR;AACA,QAAI,CAAC,aAAa,QAAQ;AACxB,aAAO;AAAA,IACT;AACA,YAAQ,aAAa,QAAQ;AAAA,MAC3B,KAAK,QAAQ;AACX,iCAAyB,IAAI;AAC7B,YAAI,MAAM,OAAO,GAAG;AAClB,iBAAO;AAAA,QACT;AACA,cAAM,IAAI,MAAM,kCAAkC,KAAK,KAAK,EAAE;AAAA,MAChE;AAAA,MACA,KAAK,aAAa;AAChB,YAAI,MAAM,YAAY,GAAG;AACvB,iBAAO;AAAA,QACT;AACA,cAAM,IAAI,MAAM,uCAAuC,KAAK,KAAK,EAAE;AAAA,MACrE;AAAA,MACA,SAAS;AACP,cAAM,IAAI,MAAM,8BAA8B;AAAA,MAChD;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAM,eAAiC;AACrC,WAAO,KAAK,OAAO,EAAE,QAAQ,OAAO,CAAC;AAAA,EACvC;AAAA,EAEA,MAAM,cAAgC;AACpC,WAAO,KAAK,OAAO,EAAE,QAAQ,YAAY,CAAC;AAAA,EAC5C;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,MAAM,SAAsD;AAChE,UAAM,iBAAiB,MAAM;AAC3B,UAAI,OAAO,YAAY,YAAY,OAAO,YAAY,UAAU;AAC9D,eAAO,EAAE,MAAM,QAAQ;AAAA,MACzB;AACA,aAAO,WAAW,CAAC;AAAA,IACrB,GAAG;AACH,UAAM,MAAM,KAAK,OAAO,EAAE,WAAW,MAAM,GAAG,cAAc,CAAC;AAC7D,WAAO;AAAA,EACT;AAAA;AAAA;AAAA,EAIA,MAAM,GACJ,aACA,SACe;AACf,UAAM,GAAG,KAAK,OAAO,IAAI,MAAK,WAAW,EAAE,OAAO,OAAO;AACzD,WAAO,IAAI,MAAK,WAAW;AAAA,EAC7B;AAAA;AAAA,EAGA,MAAM,OAAO,aAAiD;AAC5D,UAAM,OAAO,KAAK,OAAO,IAAI,MAAK,WAAW,EAAE,KAAK;AAAA,EACtD;AAAA;AAAA,EAGA,aAAa,YAAY,QAAgC;AACvD,WAAO,IAAI;AAAA,MACT,MAAM,QAAQ,IAAI,MAAK,OAAO,CAAC,EAAE,KAAK,UAAU,UAAU,EAAE,SAAS,CAAC;AAAA,IACxE;AAAA,EACF;AAAA,EAEA,MAAM,GAAG,SAAmD;AAC1D,UAAM,GAAG,KAAK,OAAO,OAAO;AAAA,EAC9B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,MAAM,SAAmD;AAC7D,UAAM,KAAK,GAAG,EAAE,WAAW,MAAM,OAAO,MAAM,GAAI,WAAW,CAAC,EAAG,CAAC;AAAA,EACpE;AAAA,EAEA,OAA4B,CAAC;AAAA;AAAA,IAE3B,SAAS,KAAK,OAAO,OAAc;AAAA;AAAA,EAErC,MAAM,WAA4B;AAChC,WAAO,SAAS,KAAK,OAAO,OAAO;AAAA,EACrC;AAAA,EAEA,MAAM,WAA0B;AAC9B,WAAO,KAAK,MAAM,MAAM,KAAK,SAAS,CAAC;AAAA,EACzC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,MACJ,MACA,SACe;AACf,UAAM,KAAK,OAAO,MAAM;AACxB,UAAM,UAAU,KAAK,OAAO,MAAM,OAAO;AACzC,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,MAAM,UACJ,MACA,WAAiD,MACjD,QAA8C,MAC/B;AACf,UAAM,KAAK,MAAM,KAAK,UAAU,MAAM,UAAU,KAAK,CAAC;AACtD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,UAA8B,CAAC;AAAA;AAAA,IAE7B,QAAQ,KAAK,OAAO,OAAc;AAAA;AAAA;AAAA,EAGpC,MAAM,QACJ,QACA,MACe;AACf,UAAM,aAAa,IAAI,MAAK,MAAM;AAClC,UAAM;AAAA,MACJ,KAAK;AAAA,MACL,WAAW;AAAA,MACX;AAAA;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA,EAEA,KAAK,SAA+D;AAClE,WAAO,KAAK,KAAK,MAAM,OAAO;AAAA,EAChC;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,SAAiE;AACrE,WAAO,MAAM,KAAK,MAAM,OAAO;AAAA,EACjC;AAAA,EAEA,WAAW,UAAgB;AACzB,WAAO,IAAI,MAAK,QAAQ,CAAC;AAAA,EAC3B;AAAA,EAEA,OAAO,MAAM;AAAA,IACX,OAAO,IAAI,MAAK,YAAY,MAAK,QAAQ,KAAK,QAAQ,CAAC;AAAA,IACvD,QAAQ,IAAI,MAAK,aAAa,MAAK,QAAQ,KAAK,SAAS,CAAC;AAAA,IAC1D,MAAM,IAAI,MAAK,WAAW,MAAK,QAAQ,KAAK,cAAc,CAAC;AAAA,IAC3D,OAAO,IAAI,MAAK,YAAY,MAAK,QAAQ,KAAK,cAAc,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA,IAK7D,SAAS,aAAa,IAAI,MAAK,UAAU,IAAI;AAAA,IAC7C,0BAA0B,aACtB,IAAI,MAAK,UAAU,IACnB,IAAI,MAAK,YAAY,MAAK,QAAQ,KAAK,cAAc,CAAC;AAAA,EAC5D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,cAAc,MAAmB;AAC/B,QAAI,KAAK,SAAS,GAAG;AACnB,cAAQ,IAAI,GAAG,IAAI;AAAA,IACrB;AACA,YAAQ,IAAI,KAAK,KAAK;AACtB,WAAO;AAAA,EACT;AACF;AAWO,SAAS,gBAAmB,OAA6B;AAC9D,MAAI,iBAAiB,MAAM;AACzB,WAAO,MAAM,SAAS;AAAA,EACxB;AACA,SAAO;AACT;AAEO,SAAS,yBAAyB,MAAkB;AACzD,MAAI,KAAK,iBAAiB,GAAG;AAC3B,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AACF;",
-  "names": []
-}