Interface PathMeta

Interface describing metadata for a path

Hierarchy

Properties

base depth dir ext name path root segments

Methods

equals exists hasRoot isEmpty isRoot isValid type

Properties

base

base: string

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

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'

name

name: string

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

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[]

Methods

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

exists

  • boolean value indicating if the path exists or not

    Returns boolean

hasRoot

  • boolean value indicating if the path has a [[root]]

    Returns boolean

isEmpty

  • boolean value indicating if the pathis [[empty]]

    Returns boolean

isRoot

  • boolean value indicating if the path is [[root]] path

    Returns boolean

isValid

  • boolean value representing if the path can be created on the disk

    Returns boolean

type

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc