Interface Path

路径

Hierarchy

  • Path

Properties

delimiter posix sep win32

Methods

basename dirname extname format isAbsolute join normalize parse relative resolve

Properties

delimiter

delimiter: ";" | ":"

特定平台的文件分隔符。 ';' 或者 ':'.

posix

posix: Path

sep

sep: "\\" | "/"

特定平台的文件分隔符。'\'或'/'。

win32

win32: Path

Methods

basename

  • 返回路径的最后一部分。类似于Unix basename命令。通常用于从完全限定的路径中提取文件名。

    Parameters

    • p: string

      求值的路径。

    • Optional ext: string

      可选地，从结果中删除的扩展。

    Returns string

dirname

  • 返回路径的目录名。类似于Unix的dirname命令。

    Parameters

    • p: string

      求值的路径。

    Returns string

extname

  • 返回路径的扩展名，在路径的最后一部分从最后一个'.'到字符串末尾。如果在路径的最后部分没有'.'或者最后一个字符时'.'则返回一个空字符串。

    Parameters

    • p: string

      求值的路径。

    Returns string

format

  • 从对象返回路径字符串——与parse()相反。

    Parameters

    Returns string

isAbsolute

  • 确定{path}是否是一个绝对路径。无论工作目录如何，绝对路径总是解析到相同的位置。

    Parameters

    • path: string

      用于测试的路径。

    Returns boolean

join

  • 将所有参数连接在一起，并规范化生成的路径。参数必须是字符串。在v0.8中，非字符串参数被悄悄地忽略。在v0.10及以上版本中，会抛出异常。

    Parameters

    • Rest ...paths: string[]

      用于连接的路径列表

    Returns string

normalize

  • 规范化字符串路径，减少'.'和'.'的部分。当发现多个斜杠时，它们被单个斜杠替换;当路径包含尾部斜杠时，它将被保留。在Windows上使用反斜杠。

    Parameters

    • p: string

      要规范化的字符串路径。

    Returns string

parse

  • 从路径字符串返回一个对象 —— 与format()相反。

    Parameters

    • pathString: string

      路径字符串。

    Returns ParsedPath

relative

  • 解决从{from}到{to}的相对路径。有时我们有两条绝对路径，我们需要推导出一条到另一条的相对路径。这实际上是path.resolve的逆变换。

    Parameters

    • from: string

      起始路径

    • to: string

      目标路径

    Returns string

resolve

  • 最右边的参数被认为是{to}。其他参数被认为是{from}的数组。

    从最左边的{from}参数开始，将{to}解析为一个绝对路径。

    如果{to}还不是绝对的，则{from}参数将按从右到左的顺序预先设置，直到找到绝对路径为止。如果在使用所有{from}路径之后仍然没有找到绝对路径，则还将使用当前工作目录。得到的路径是规范化的，除非路径被解析到根目录，否则尾部斜杠将被删除。

    Parameters

    • Rest ...pathSegments: string[]

      要连接的字符串路径。非字符串参数将被忽略。

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc