xtool.js v1.2.2

要跑UT请先安装Jest: npm i jest

xtool

Enchance file, number feature of node

Functions

xFile

File relative tools of xTool

Kind: global variable

xHtml

HTML relative tools of xTool

Kind: global variable

xNumber

Number relative tools of xTool

Kind: global variable

xUtil

Utility of xTool

Kind: global variable

prepareDir(dir)

Enchance file, number feature of node

Kind: global function

Kind: global variable

readDir(root, setting) => array

Get file list from a root path with configure

Kind: global function
Returns: array - list of file with absolute/relative path

readFile(file, encoding) => string

Read file content

Kind: global function
Returns: string - if file not exist, will return empty string

existFile(file) => boolean

Test file exist or not

Kind: global function

existDir(dir) => boolean

Test dir exist or not

Kind: global function

saveFile(file, content, encoding)

Save content to file

Kind: global function

removeFile(file) => boolean

Alias of fs.unlinkSync

Kind: global function
Returns: boolean - if file not exist, return false

scanFile(file, callback)

scan file by line, and do callback to content of each line

Kind: global function

scanListFile(list, callback)

scan all file in list by line, and do callback to content of each line

Kind: global function

replaceFile(file, pattern|callback, replacement)

replace file content with pattern & replacement

Kind: global function

decodeHtml(htmlContent) => string

transfer &#DDDD; & &#xHHHH; it was. make sure the html page under utf-8;

Kind: global function

tolerant(num) => string

修正中文数字常见的错误，并转小写

Kind: global function
Returns: string - 不校验数字拼写是否正确，只转换常错的拼写

numberChnToBig(num) => string

中文数字小写转大写，“万”，“亿”是不区分大小写的

Kind: global function
Returns: string - 不校验数字拼写是否正确，只转换大写

numberChnToSmall(num) => string

中文数字小写转大写，“万”，“亿”是不区分大小写的

Kind: global function
Returns: string - 不校验数字拼写是否正确，只转换大写

numberAri2Chn(num) => string

阿拉伯数字转中文数字

Kind: global function
Returns: string - 返回中文数字

numberChn2Ari(num) => number

中文数字转阿拉伯数字

Kind: global function
Returns: number - 返回阿拉伯数字, 返回-1表示中文数字非法

isLegalChnNum(num) => string

检查中文数字合法性，能通过基本容错也为合法

Kind: global function
Returns: string - true表示合法中文数字

numberAri2Roman(num) => string

阿拉伯数字转罗马数字

Kind: global function

numberRoman2Ari(s) => number

罗马数字转阿拉伯数字

Kind: global function

typeof(arg) => string

return the truly type of arg

Kind: global function
Returns: string - type of arg

is(value, type) => boolean

compare the value type with expect type

Kind: global function

flattenArray(arg) => array

recursive embeded array to a flat array, and will remove duplicated value

Kind: global function
Returns: array - return a one dimension array

distinctArray(arg) => array

remove duplicated value of array

Kind: global function
Returns: array - return an array with every unquie value

getArgs() => object

get node command args

Kind: global function
Returns: object - - command line: "node xxx.js -a 111 -b=222 333 -d", will return { 0: "-a", "111", "-b=222", "333", "-d", 1: "-a", 2: "111", 3: "-b=222", 4: "333", "5": "-d", "-a": "111", "-b": "222", "-d": true }

range(start, end) => array

generate values array of specified range, number range should be 0 to 2^32

Kind: global function