Path | /path/path.ts | yxz@0.17.0

class Path

import { Path } from "https://deno.land/x/yxz@0.17.0/path/path.ts";

A class to represent filesystem path.

Constructors

new

private

Path(filepath: string)

Properties

private

readonly

[filepathSymbol]: string

readonly

ext

Return the extension of path.

readonly

name

Return the name of path.

readonly

parent

readonly

parents: Array<Path>

readonly

stem

Return the name of the path, without extension.

readonly

[Symbol.toStringTag]

Methods

chmod(mode: number)

chmodSync(mode: number)

chown(uid: number | null, gid: number | null)

chownSync(uid: number | null, gid: number | null)

copyFile(toPath: Path | string | URL)

copyFileSync(toPath: Path | string | URL)

create()

ensureSymlink(dest: Path | string)

ensureSymlinkSync(dest: Path | string)

equals(otherPath:

| Path

| string

| undefined

| null

)

exists()

expanduser()

Return a new path with expanded ~ and ~user constructs.

If a home directory can’t be resolved, an error is raised.

glob(glob: string, opts?: GlobOptions): AsyncIterableIterator<Path>

globSync(glob: string, opts?: GlobOptions): IterableIterator<Path>

isAbsolute()

isDir(): Promise<boolean>

isFile(): Promise<boolean>

isSymlink(): Promise<boolean>

joinpath(...other: string[])

link(newpath: Path | string)

linkSync(newpath: Path | string)

lstat()

lstatSync()

mkdir(options?: Deno.MkdirOptions)

mkdirSync(options?: Deno.MkdirOptions)

move(dest: Path | string, options?: { overwrite?: boolean; })

moveSync(dest: Path | string, options?: { overwrite?: boolean; })

open(options?: Deno.OpenOptions)

openSync(options?: Deno.OpenOptions)

parse()

readDir()

readDirSync()

readFile(options?: Deno.ReadFileOptions)

readFileSync()

readJsonFile<T = JsonValue>(options?: Deno.ReadFileOptions)

readLink()

readLinkSync()

readTextFile(options?: Deno.ReadFileOptions)

readTextFileSync()

realPath()

realPathSync()

relative(otherPath: Path)

remove(options?: Deno.RemoveOptions)

removeSync(options?: Deno.RemoveOptions)

rename(newpath: Path | string | URL): Promise<Path>

renameSync(newpath: Path | string | URL): Path

resolve()

stat()

statSync()

symlink(newpath: Path | string | URL, options?: Deno.SymlinkOptions)

symlinkSync(newpath: Path | string | URL, options?: Deno.SymlinkOptions)

toFileUrl()

toJSON()

toString()

truncate(len?: number)

truncateSync(len?: number)

walk(options?: WalkOptions)

walkSync(options?: WalkOptions)

watch(options?: { recursive: boolean; })

writeFile(data: Uint8Array, options?: Deno.WriteFileOptions)

writeFileSync(data: Uint8Array, options?: Deno.WriteFileOptions)

writeJsonFile(value: JsonValue, options?: Deno.WriteFileOptions & { replacer?: (number | string)[] | null; space?: string | number; })

writeTextFile(data: string, options?: Deno.WriteFileOptions)

writeTextFileSync(data: string, options?: Deno.WriteFileOptions)

[Symbol.for("Deno.customInspect")]()

[Symbol.toPrimitive](hint: string)

Static Properties

_cache: Cache

readonly

delimiter

readonly

sep

Static Methods

cache(...pathSegments: string[])

config(...pathSegments: string[])

cwd(...pathSegments: string[])

Returns path representing the current directory.

exe(name: string): Promise<Path | undefined>

Searches for an executable named file in the directories named by the PATH environment variable.

from(...pathSegments: string[])

fromFileUrl(url: string | URL)

fromImportMeta(importMeta: ImportMeta, url?)

Returns path relative to import.meta.

Note: As hosted script don't reoslve to file system path, library should avoid this method.

fromPathObject(pathObject: FormatInputPathObject)

home(...pathSegments: string[])

Returns path representing the user’s home directory.

If the home directory can’t be resolved, throw error.

makeTempDir(options?: Deno.MakeTempOptions)

makeTempDirSync(options?: Deno.MakeTempOptions)

makeTempFile(options?: Deno.MakeTempOptions)

makeTempFileSync(options?: Deno.MakeTempOptions)

splitPATH()

Converts the PATH environment variable into an array of Path instances.