blear.node.path

1Introduction

description：Node 端路径解析、判断、操作
author：ydr.me
create：2015-09-01 19:36
update：2015-09-01 19:36
github：https://github.com/blearjs/blear.node.template

2Example

var path = require('blear.node.path');

3Static

3.1`.basename(path): basename`

获取路径的基本名称（除去扩展名）。

path.basename('path/to/file.name.ext');
// => "file.name"

3.1.1`path`

类型：String
说明：路径

3.1.2`basename`

类型：String
说明：基本名称

3.2`.extname(path): extname`

获取路径的扩展名。

path.extname('path/to/file.name.ext');
// => ".ext"

3.2.1`path`

类型：String
说明：路径

3.2.2`extname`

类型：String
说明：扩展名

3.3`.dirname(path): dirname`

获取路径的目录。

path.dirname('path/to/file.name.ext');
// => "path/to/"

3.3.1`path`

类型：String
说明：路径

3.3.2`dirname`

类型：String
说明：目录

3.4`.relative(from, to): relative`

路径切换距离。

path.relative('path/to/a/b/c', 'path/to/a');
// => "../../"

3.4.1`from`

类型：String
说明：起始路径

3.4.2`to`

类型：String
说明：终点路径

3.4.3`relative`

类型：String
说明：切换距离

3.5`.resolve(point...): path`

路径合并，如果是相对路径，则会添加上当前工作目录（process.cwd()）。

path.resolve('path/to/', '123');
// => "/Users/balabala/path/to/123"

path.resolve('/path/to/', '123');
// => "/path/to/123"

path.resolve('/path/to/', '123', '456/789');
// => "/path/to/123/456/789"

3.5.1`point`

类型：String
说明：路径点

3.5.2`path`

类型：String
说明：合并后的路径

3.6`.join(point...): path`

路径合并。

path.join('path/to/', '123');
// => "/Users/balabala/path/to/123"

path.join('/path/to/', '123');
// => "/path/to/123"

path.join('/path/to/', '123', '456/789');
// => "/path/to/123/456/789"

3.6.1`point`

类型：String
说明：路径点

3.6.2`path`

类型：String
说明：合并后的路径

3.7`.normalize(path1): path2`

路径标准化处理。

path.normalize('path/to/');
// => "path/to/"

path.normalize('path/to\\def');
// => "path/to/def"

path.normalize('path/to\\def//123');
// => "path/to/def/123"

3.7.1`path1`

类型：String
说明：标准化处理之前的路径

3.7.2`path`

类型：String
说明：标准化处理之后的路径

3.8`.glob(globArray, options): files`

glob 规则匹配。

path.glob('path/to/**');
path.glob([
    'path/to/*.jpg',
    'path/to/*.png'
], {
    progress: function(indexGlob, indexFile, file) {
        // 进度
    }
});
// => 
// [
//    [
//        "path/to/a.jpg"
//        "path/to/b.jpg"
//    ],
//    [
//        "path/to/a.png"
//        "path/to/b.png"
//    ]
// ]

3.8.1`globArray`

类型：String | Array
说明：glob 规则

3.8.2`options`

类型：Object

说明：匹配配置，默认为：

默认 = {
  // 起始目录（工作目录）
  srcDirname: null,
  globOptions: {
      // 是否匹配点开头的文件
      dot: false,

      // 是否不匹配目录
      nodir: true
  },
  // 进度（方法）
  progress: null
};