Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FSUtil

FS utilities API.

Hierarchy

  • FSUtil

Index

Methods

Methods

combinePath

  • combinePath(rootPath: string, ...paths: string[]): string

  • Combines paths.

    Parameters

    • rootPath: string

      The root path.

    • Rest ...paths: string[]

      The paths to add to it.

    Returns string

deconstructFullPath

  • deconstructFullPath(_fp: string): { path: string; prefix: string }

  • Extracts the prefix and path from a path string.

    Parameters

    • _fp: string

      The file path to use.

    Returns { path: string; prefix: string }

    • path: string
    • prefix: string

downloadFile

  • downloadFile(path: string): Promise<void>

  • Downloads a file to the user hard disk.

    Parameters

    • path: string

      The path to download.

    Returns Promise<void>

fixPath

  • fixPath(path: string): string

  • Fixes a path.

    Parameters

    • path: string

      The path to fix.

    Returns string

    The fixed path.

fname

  • fname(path: string): string

  • Returns the file name of a path.

    Parameters

    • path: string

      The path to return the filename for.

    Returns string

getExtension

  • getExtension(path: string, ignoreCase?: boolean): string

  • Returns the file extension of a path.

    Parameters

    • path: string

      The path to extract the extension of.

    • Optional ignoreCase: boolean

      Whether to ignore the extension case.

    Returns string

getParentPath

  • getParentPath(path: string): string

  • Returns the parent path of a path.

    Parameters

    • path: string

      The path to resolve for.

    Returns string

normalizeDriveLetter

  • normalizeDriveLetter(path: string): string

  • Fix drive letter case in path.

    Parameters

    • path: string

      The path.

    Returns string

resolvePath

  • resolvePath(basePath: string, path: string): string

  • Resolves a path.

    Parameters

    • basePath: string

      The base path.

    • path: string

      The path to resolve.

    Returns string

Generated using TypeDoc