kitx Version: 1.0.0 By @Jackson Tian

toolkit

index: API索引


loadJSONSync

Load .json file synchronous.

方法签名

方法 exports.loadJSONSync()
参数 filename(String)

absolute file path

返回 Object

a parsed object

encode

Encoding a string to Buffer safely

方法签名

方法 exports.encode()
参数 str(String)

string.

参数 encoding.(String)

optional.

返回 Buffer

encoded buffer

makeHasher

Generate a haser with specfied algorithm

方法签名

方法 exports.makeHasher()
参数 algorithm(String)

can be md5, etc.

返回 Function

a haser with specfied algorithm

md5

Get md5 hash digests of data

方法签名

属性 exports.md5
参数 data(String,Buffer)

data.

参数 encoding(String)

optionnal. can be 'hex', 'binary', 'base64'.

返回 String,Buffer

if no encoding is provided, a buffer is returned.

sha1

Get sha1 hash digests of data

方法签名

方法 exports.sha1()
参数 data(String,Buffer)

data.

参数 key(String)

the key.

参数 encoding(String)

optionnal. can be 'hex', 'binary', 'base64'.

返回 String,Buffer

if no encoding is provided, a buffer is returned.

random

Get a random value in a range

方法签名

方法 exports.random()
参数 min(Number)

range start.

参数 max(Number)

range end.

sleep

sleep a while.

方法签名

方法 exports.sleep()
参数 in(Number)

milliseconds

返回 Promise

a Promise