Interface FlexiPath

A flexible path builder and walker

Hierarchy

Properties

base children depth dir ext files name parent path root segments subDirectories

Methods

append cut diff equals except exists flatten hasRoot intersect isEmpty isRoot isValid pop prepend read reverse type walk write

Properties

base

base: string

The file name including extension (if any) such as 'index.html'

children

children: ChildQuery

The [[subDrirectories]] and [[files]] for a given path

depth

depth: number

The depth of this path

dir

dir: string

The full directory path such as '/home/user/dir' or 'c:\path\dir'

ext

ext: string

The file extension (if any) such as '.html'

files

files: ChildQuery

The files in the current path

name

name: string

The file name without extension (if any) such as 'index'

parent

parent: ParentQuery

The parent directory of the path

path

path: string

The normalized string representation of the path

root

root: string

The root of the path such as '/' or 'c:'

segments

segments: string[]

subDirectories

subDirectories: ChildQuery

The subdirectories of the path and a path builder

Methods

append

cut

diff

  • Get the diff for two paths

    Parameters

    • path: Path

      The path to diff against

    Returns [FlexiPath, FlexiPath]

    Example

    const first = flexi.path("some/common/and/unique/paths");
    const second = flexi.path("some/common/with/other/paths");
    const diff = first.diff(second);
    //==> [ "and/unique/paths", "with/other/paths" ]

equals

  • Checks if this path equals another path

    Parameters

    • other: Path

      the path to compare with

    • Optional options: {
          ignoreFileExtension?: boolean;
      }

      options

      • Optional ignoreFileExtension?: boolean

    Returns boolean

except

exists

flatten

hasRoot

intersect

isEmpty

isRoot

isValid

pop

prepend

read

reverse

type

walk

write

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc