https://github.com/ulivz/supath
An additional path parsing module for nodejs
https://github.com/ulivz/supath
nodejs npm parser path path-parsing
Last synced: 2 months ago
JSON representation
An additional path parsing module for nodejs
- Host: GitHub
- URL: https://github.com/ulivz/supath
- Owner: ulivz
- Created: 2017-03-17T18:07:48.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-07-30T16:36:20.000Z (almost 7 years ago)
- Last Synced: 2026-03-30T09:29:27.299Z (3 months ago)
- Topics: nodejs, npm, parser, path, path-parsing
- Language: JavaScript
- Size: 16.6 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# supath
[]()
[]()
[]()
An additional path parsing module for nodejs
# Qucik Start
installation:
```
$ npm install supath --save-dev
```
Introduced in the project:
```js
var supath = require('supath')
var aPath = './config/global/global-config.ts'
var result = supath.parse(aPath)
```
`result` will get the following values:
```json
{
"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)
- ParamType: `String`
- Description: `Check if a file name is valid`
## supath.getPathSep(path)
- Type: `String`
- Description: `Gets a delimiter for a path`
This method is not used to get the system's delimiter
and Returns `undefined` if the path contains `/` or both`\`
## supath.isFilePath(path)
- ParamType: `String`
- Description: `detect whether a string meets the requirements of the [directory] 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`:
```markdown
http://tool.chinaz.com/regex/toxichl.html
C:\Program Files\ASUS\AMDA\AXSP\ATKEX.dll
```
## supath.isDirPath(path)
- ParamType: `String`
- Description: `detect whether a string meets the requirements of the [directory] path`
The following example will return `true`:
```markdown
- http://tool.chinaz.com/regex.
- http://tool.chinaz.com/regex/
- http://tool.chinaz.com/regex
```
## supath.parse(path)
- ParamType: `String`
- Description: `Returns the various details of a 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)
- ParamType: `(String, Boolean)`
- Description: `Directory path normalization - directory path ends with '/' or no '\`
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 `\`