posix

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

WARNING

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

Summary

Entry	Description
Path
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).
extname	Returns the file extension of path (including the leading dot), or "" if there is none.
format	Converts path to its POSIX string representation.
isAbsolute	Returns true if path is absolute (begins with /).
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 be of the same kind (both absolute or both relative).
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 = posixtypes.Path

---

Pathlike

type Pathlike = posixtypes.Pathlike

---

Functions and Properties

posix.basename

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

(path: Pathlike) -> string?

---

posix.dirname

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

(path: Pathlike) -> string

---

posix.extname

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

(path: Pathlike) -> string

---

posix.format

Converts path to its POSIX string representation.

(path: Pathlike) -> string

---

posix.isAbsolute

Returns true if path is absolute (begins with /).

(path: Pathlike) -> boolean

---

posix.join

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

(...: Pathlike) -> Path

---

posix.normalize

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

(path: Pathlike) -> Path

---

posix.parse

Parses path into a structured Path value.

(path: Pathlike) -> Path

---

posix.pathmt

pathinterface.PathInterface

---

posix.pathmt:__tostring

() -> string

---

posix.relative

Returns the relative path from from to to. Both paths must be of the same kind (both absolute or both relative).

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

---

posix.resolve

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

(...: Pathlike) -> Path

---