Class DocometPath

Path

Hierarchy (View Summary)

DocometInspectableObjectClass
- DocometPath

Index

Constructors

Accessors

base dir ext name rootPath

Methods

toJSON toPosixString toString with absolute doesNotExist exists findUp join joinPosix new parse rebuild relative split splitPosix

Constructors

constructor

new DocometPath(dir: string, name?: string, ext?: string): DocometPath
Creates a DocometPath instance
Parameters
- dir: string
  The directory path
- Optionalname: string
  The file name
- Optionalext: string
  The file extension
Returns DocometPath
Overrides DocometInspectableObjectClass.constructor
- Defined in src/docomet-path.ts:200

Accessors

base

get base(): string
Full file name (name + ext)

Returns string
- Defined in src/docomet-path.ts:187

dir

get dir(): string
Directory path

Returns string
- Defined in src/docomet-path.ts:168

ext

get ext(): string
File extension with leading dot

Returns string
- Defined in src/docomet-path.ts:182

name

get name(): string
File name without extension

Returns string
- Defined in src/docomet-path.ts:175

`Static`rootPath

get rootPath(): string
Root path

Returns string
- Defined in src/docomet-path.ts:26

Methods

toJSON

toJSON(): string
Get the JSON representation of the path

Returns string
The JSON representation
- Defined in src/docomet-path.ts:246

toPosixString

toPosixString(): string
Get the posix string representation of the path

Returns string
The posix string representation
- Defined in src/docomet-path.ts:238

toString

toString(): string
Get the string representation of the path

Returns string
The string representation
Overrides DocometInspectableObjectClass.toString
- Defined in src/docomet-path.ts:230

with

with(updates: Partial<{ dir: string; ext: string; name: string }>): DocometPath
Create a new DocometPath instance with updated properties
Parameters
- updates: Partial<{ dir: string; ext: string; name: string }>
  The updated properties
Returns DocometPath
The DocometPath instance
- Defined in src/docomet-path.ts:216

`Static`absolute

absolute(path: string): string
Convert a path to an absolute path
Parameters
- path: string
  The path
Returns string
The absolute path
- Defined in src/docomet-path.ts:83

`Static`doesNotExist

doesNotExist(path: string): boolean
Check if a path does not exist
Parameters
- path: string
  The path
Returns boolean
true if does not exist, otherwise false
- Defined in src/docomet-path.ts:74

`Static`exists

exists(path: string): boolean
Check if a path exists
Parameters
- path: string
  The path
Returns boolean
true if exists, otherwise false
- Defined in src/docomet-path.ts:65

`Static`findUp

findUp(name: string, startPath?: string): string | undefined
Find a file or directory up the directory tree
Parameters
- name: string
  The name to find
- startPath: string = DocometPath.#rootPath
  The path to start searching from
Returns string | undefined
The absolute path to the found item, or undefined if not found
- Defined in src/docomet-path.ts:42

`Static`join

join(this: void, ...paths: string[]): string
Join paths by the platform separator
Parameters
- this: void
- ...paths: string[]
  The paths
Returns string
The joined path
- Defined in src/docomet-path.ts:120

`Static`joinPosix

joinPosix(this: void, ...paths: string[]): string
Join paths by the posix separator
Parameters
- this: void
- ...paths: string[]
  The paths
Returns string
The joined path
- Defined in src/docomet-path.ts:129

`Static`new

new(...args: [dir: string, name?: string, ext?: string]): DocometPath
Create a new DocometPath instance
Parameters
- ...args: [dir: string, name?: string, ext?: string]
  The constructor arguments
Returns DocometPath
The DocometPath instance
- Defined in src/docomet-path.ts:159

`Static`parse

parse(path: string): DocometPath
Parse a path string into a DocometPath instance
Parameters
- path: string
  The path string
Returns DocometPath
The DocometPath instance
- Defined in src/docomet-path.ts:149

`Static`rebuild

rebuild(
    this: void,
    path: string,
    split: DocometPathSplit,
    join: DocometPathJoin,
): string
Rebuild a path using split and join functions
Parameters
- this: void
- path: string
  The path
- split: DocometPathSplit
  The split function
- join: DocometPathJoin
  The join function
Returns string
The rebuilt path
- Defined in src/docomet-path.ts:140

`Static`relative

relative(targetPath: string, rootPath?: string): string
Get the relative path from the root path
Parameters
- targetPath: string
  The target path
- rootPath: string = DocometPath.#rootPath
  The root path
Returns string
The relative path
- Defined in src/docomet-path.ts:93

`Static`split

split(this: void, path: string): string[]
Split a path by the platform separator
Parameters
- this: void
- path: string
  The path
Returns string[]
The split path
- Defined in src/docomet-path.ts:102

`Static`splitPosix

splitPosix(this: void, path: string): string[]
Split a path by the posix separator
Parameters
- this: void
- path: string
  The path
Returns string[]
The split path
- Defined in src/docomet-path.ts:111