nupp.io.path.spi

Implementation interfaces consumed during ordinary module initialization. Discover with nupp.spi.load; the consumer chooses the unique highest priority. Omitted priority is zero. Importing these declarations loads no implementation.

Module contents

Types

TypeKindDescription
ProviderinterfaceEnvironmental path facts, independent of lexical path manipulation.

Types#

Providerinterface#

interface Provider ...

Environmental path facts, independent of lexical path manipulation.

separator reports the host convention. currentDirectory and canonicalize may return nil with an explanatory message when the host has no such facility or an operating-system operation fails. Public Path identity remains in nupp.io.path.

Members

NameKindDescription
priorityfield
separatormethodReturns the host path separator.
currentDirectorymethodReturns the process directory or nil and an environmental error.
canonicalizemethodResolves a host filesystem path or returns nil and an error.

priorityfield#

priority: integer?
@readonly

separatormethod#

separator: function(): string
@readonly

Returns the host path separator.

Returns
TypeDescription
string

currentDirectorymethod#

currentDirectory: function(): (string?, string?)
@readonly

Returns the process directory or nil and an environmental error.

Returns
TypeDescription
string?
string?

canonicalizemethod#

canonicalize: function(path: string): (string?, string?)
@readonly

Resolves a host filesystem path or returns nil and an error.

Arguments
NameTypeDescription
pathstring
Returns
TypeDescription
string?
string?