win32

local win32 = require("@std/path/win32")

WARNING

These APIs are still open to future evolution. In new major versions, they may change in backwards incompatible ways.

Summary

Entry	Description
Path
PathKind
Pathlike
basename	Returns the last component of path, or nil if the path has no components.
dirname	Returns the directory portion of path as a string (everything except the last component).
drive	Returns a Path representing just the drive root of path (e.g. C:\). Errors if path has no drive letter.
extname	Returns the file extension of path (including the leading dot), or "" if there is none.
format	Converts path to its Windows string representation using backslash separators.
isAbsolute	Returns true if path is absolute (drive-rooted or UNC).
join	Joins one or more path segments into a single Path. Each segment after the first must be relative.
normalize	Returns a normalized form of path, resolving . and .. components and removing redundant separators.
parse	Parses path into a structured Path value.
pathmt
pathmt:__tostring
relative	Returns the relative path from from to to. Both paths must have the same kind and drive.
resolve	Resolves a sequence of paths into an absolute Path, processing right-to-left and falling back to the current working directory.

---

Types

Path

type Path = win32types.Path

---

PathKind

type PathKind = win32types.PathKind

---

Pathlike

type Pathlike = win32types.Pathlike

---

Functions and Properties

win32.basename

Returns the last component of path, or nil if the path has no components.

(path: Pathlike) -> string?

---

win32.dirname

Returns the directory portion of path as a string (everything except the last component).

(path: Pathlike) -> string

---

win32.drive

Returns a Path representing just the drive root of path (e.g. C:\). Errors if path has no drive letter.

(path: Pathlike) -> Path

---

win32.extname

Returns the file extension of path (including the leading dot), or "" if there is none.

(path: Pathlike) -> string

---

win32.format

Converts path to its Windows string representation using backslash separators.

(path: Pathlike) -> string

---

win32.isAbsolute

Returns true if path is absolute (drive-rooted or UNC).

(path: Pathlike) -> boolean

---

win32.join

Joins one or more path segments into a single Path. Each segment after the first must be relative.

(...: Pathlike) -> Path

---

win32.normalize

Returns a normalized form of path, resolving . and .. components and removing redundant separators.

(path: Pathlike) -> Path

---

win32.parse

Parses path into a structured Path value.

(path: Pathlike) -> Path

---

win32.pathmt

pathinterface.PathInterface

---

win32.pathmt:__tostring

() -> string

---

win32.relative

Returns the relative path from from to to. Both paths must have the same kind and drive.

(from: Pathlike, to: Pathlike) -> Path

---

win32.resolve

Resolves a sequence of paths into an absolute Path, processing right-to-left and falling back to the current working directory.

(...: Pathlike) -> Path

---