閱讀(1.9k) 書簽贊(0) 我要糾錯(cuò)

util.md

2018-11-22 19:22 更新

`ngui/util`

version()

獲取Ngui版本號(hào)字符串

@ret {String}

fatal(err)

拋出致命異常

hashCode(string)

獲取字符串的哈希代碼值

@arg string {String}
@ret {int}

hash(string)

獲取字符串的哈希值，與hashCode()的區(qū)別在于，這個(gè)方法會(huì)將哈希代碼轉(zhuǎn)換為字符串

@arg string {String}
@ret {String}````

id()

獲取自增id每次調(diào)用都會(huì)將這個(gè)id加1并返回

runScript(source,name[,sandbox])

編譯運(yùn)行一段javascript代碼并返回運(yùn)行結(jié)果,與eval函數(shù)類似,但這個(gè)方法可以指定一個(gè)名稱與一個(gè)運(yùn)行上下文對(duì)像

如果要執(zhí)行Ngui js or jsx 代碼需先使用 util.transformJs() or util.transformJsx() 進(jìn)行轉(zhuǎn)換

名稱在調(diào)試代碼或程序發(fā)生異常時(shí)非常有用

如果不傳入這個(gè)沙盒sandbox上下文默認(rèn)使用global對(duì)像

@arg source {String} javascript源代碼字符串
@arg name {String} 必需要指定這個(gè)名稱
@arg [sandbox] {Object}
@ret {Object} 返回執(zhí)行結(jié)果

transformJsx(source,name)

轉(zhuǎn)換Ngui jsx代碼為普通的可運(yùn)行的js代碼

轉(zhuǎn)換失敗會(huì)拋出異常,成功則返回新的代碼

@arg source {String}
@arg name {String}
@ret {String}

transformJs(source,name)

轉(zhuǎn)換Ngui js代碼為普通的可運(yùn)行的js代碼

轉(zhuǎn)換失敗會(huì)拋出異常,成功則返回新的代碼

@arg source {String}
@arg name {String}
@ret {String}

noop()

空操作,調(diào)用后什么也不會(huì)做

extend(obj, extd)

把extd是的屬性擴(kuò)展到obj對(duì)像上

@arg obj {Object}
@arg extd {Object}
@ret {Object} 返回obj對(duì)像

update(obj, extd)

把extd是的屬性更新到obj對(duì)像上

會(huì)忽略obj對(duì)像上不存在的屬性或類型不相同的屬性

@arg obj {Object}
@arg extd {Object}
@ret {Object} 返回obj對(duì)像

err(err)

創(chuàng)建一個(gè)Error異常對(duì)像,可以通過(guò)異常字符串創(chuàng)建也可通過(guò)Object對(duì)像創(chuàng)建

如果傳入?yún)?shù)已經(jīng)是一個(gè)Error對(duì)像,不做任何處理立即返回

@arg err {String|Object|Error}
@ret {Error}

Example:

var e = util.err('Err')
var e2 = util.err({message:'Err'})
var e3 = util.err(e);
throw e;

throw(err[,cb])

拋出一個(gè)異常,如果傳入cb會(huì)拋出一個(gè)回調(diào)異常

@arg err {String|Object|Error}
@arg [cb] {Function}

cb([cb])

返回回調(diào),不傳入cb會(huì)返回一個(gè)空函數(shù)，如果傳入了cb參數(shù)會(huì)立即返回并不會(huì)判斷其類型

@arg [cb] {Function}
@ret {Function}

isDefaultThrow(func)

測(cè)試回調(diào)函數(shù)的異常處理函數(shù)是否為默認(rèn)

@arg cb {Function}
@ret {bool}

Example:

// Prints: true
console.log(util.isDefaultThrow(function(){ }));
// Prints: false
console.log(util.isDefaultThrow(function(){ }.catch(e=>{ }));

get(name[,that])

通過(guò)點(diǎn)記名稱獲取對(duì)像屬性

@arg name {String] 名稱
@arg [that=global] {Object} 不傳入此參數(shù)默認(rèn)為global

set(name,value[,that])

通過(guò)點(diǎn)記名稱設(shè)置屬性值，并返回被更改的對(duì)像

@arg name {String}
@arg value {Object}
@arg [that=global] {Object}
@ret {Object}

del(name[,that])

通過(guò)點(diǎn)記名稱刪除對(duì)像屬性

@arg name {String}
@arg [that=global] {Object}

Example:

var that = { a:{ b: { c: 100 } } };
// Prints: 100
console.log(util.get('a.b.c', that))
// Prints: 
// {
//   c: 100,
//   c1: 200    
// }
// {
//   c: 100,
//   c1: 200    
// }
console.log(util.set('a.b.c1', 200, that))
console.log(that.a.b);
// Prints: 
// {
//   c: 100
// }
util.del('a.b.c1', that)
console.log(that.a.b);

random([start,[end]])

獲取在start到end之間的隨機(jī)數(shù)

@arg [start=0] {int}
@arg [end=1e8] {int}
@ret {int}

fixRandom(chance[,...chances])

通過(guò)概率隨機(jī)獲取從0到傳入概率數(shù)量arguments.length的隨機(jī)數(shù)

傳入的概率之和不能為0

@arg chance {float}
@arg [...chances] {float}
@arg {uint}

Example:

// Prints: 3 5 9
console.log(util.random(0, 10))
console.log(util.random(0, 10))
console.log(util.random(0, 10))
// Prints 0 3 2
console.log(util.fixRandom(10, 20, 30, 40))
console.log(util.fixRandom(10, 20, 30, 40))
console.log(util.fixRandom(10, 20, 30, 40))

clone(obj)

深度克隆obj對(duì)像

@arg obj {Object}
@ret {Object}

wrap(obj)

包裹obj對(duì)像與Object.create()功能相同

@arg obj {Object}
@ret {Object}

extendClass(cls, extd)

擴(kuò)展Class

@arg cls {Class}
@arg extd {Class|Object}

Example:

class A { test() { } }
class B { test2() { } }
util.extendClass(B, A)
util.extendClass(B, { test3: function() { } })

equalsClass(baseclass,subclass)

測(cè)試兩個(gè)subclass是否為baseclass的子類或相同

@arg subclass {Class}
@arg baseclass {Class}
@ret {bool}

select(default,value)

選取值,如果value的類型與default相同選擇value否則選擇default

@arg default {Object}
@arg value {Object}
@ret {Object}

filter(obj,filters[,non])

通過(guò)名稱列表過(guò)濾obj對(duì)像屬性,并返回過(guò)濾后的新Object

non=true表示反選

@arg obj {Object}
@arg filters {Array}
@arg [non=false] {bool}
@ret {Object}

Example:

// Prints:
//{
//  a: "a",
//  c: "c"
//} 
//{
//  b: "b",
//  d: "d"
//}
var obj = { a:'a',b:'b',c:'c', d:'d' };
console.log(util.filter(obj, ['a', 'c'])
console.log(util.filter(obj, ['a', 'c'], true)