Lute

Appearance

types ​

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

WARNING

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

Summary ​

EntryDescription
PathA structured POSIX path.
PathDataThe raw data of a POSIX path: an array of components and a flag indicating whether the path is absolute.
PathlikeAnything that can be used as a POSIX path: a string, a Path, or raw PathData.

Types ​

Path ​

A structured POSIX path.

luau
type Path = setmetatable<PathData, pathinterface.PathInterface>

PathData ​

The raw data of a POSIX path: an array of components and a flag indicating whether the path is absolute.

luau
type PathData = {
	parts: { string },
	absolute: boolean,
}

Pathlike ​

Anything that can be used as a POSIX path: a string, a Path, or raw PathData.

luau
type Pathlike = string | Path | PathData