ulivz / supath

An additional path parsing module for nodejs
2 stars 0 forks source link
nodejs npm parser path path-parsing

supath

[Travis branch]() [npm]() [Packagist]()

An additional path parsing module for nodejs

Qucik Start

installation:

$ npm install supath --save-dev

Introduced in the project:

var supath = require('supath')

var aPath = './config/global/global-config.ts'

var result = supath.parse(aPath)

result will get the following values:

{
  "fileCheck": true,
  "dirCheck": false,
  "base": "global-config.ts",
  "file": "global-config",
  "dotSuffix": ".ts",
  "suffix": "ts",
  "dir": "./config/global/",
  "fullPath": "./config/global/global-config.ts"
}

More api please continue to look down.

API

supath.checkFileName(fileName)

supath.getPathSep(path)

This method is not used to get the system's delimiter and Returns undefined if the path contains / or both\

supath.isFilePath(path)

this method differs from fs.statSync(path).isFile() Path checking does not require that the file or pointed to must exist Just used to verify the legitimacy of the path

The following example will return true:

http://tool.chinaz.com/regex/toxichl.html
C:\Program Files\ASUS\AMDA\AXSP\ATKEX.dll

supath.isDirPath(path)

The following example will return true:

- http://tool.chinaz.com/regex.
- http://tool.chinaz.com/regex/
- http://tool.chinaz.com/regex

supath.parse(path)

the description of the Returning object:

key desc
fileCheck Whether it is a file path
dirCheck Whether it is a directory path
base File name + '.' + Suffix name (eg: index.html)
file File name (eg: index)
dotSuffix '.' + Suffix name (eg: .html)
suffix Suffix name (eg: html)
dir Directory name (eg: http://tool.chinaz.com/regex/)
fullPath The original path

supath.standardDir(path, flag)

The default value of flag is true, For the role of flag, please see the table below

flag desc
true returns the path string with \ at the end
false return to the end of the path string without \