chimee-helper-utils
Version:
166 lines (93 loc) • 7.55 kB
Markdown
# chimee-helper-utils
[](https://travis-ci.org/Chimeejs/chimee-helper-utils.svg?branch=master)
[](https://coveralls.io/github/Chimeejs/chimee-helper-utils?branch=master)
[](https://www.npmjs.com/package/chimee-helper-utils)
[](https://david-dm.org/Chimeejs/chimee-helper-utils)
[](https://david-dm.org/Chimeejs/chimee-helper-utils?type=dev)
utils of chimee
## get started
```shell
npm install chimee-helper-utils --save
```
if you are using `flow`, you should import our flow defination, by adding this to your `.flowconfig`.
[ignore]
[include]
[libs]
./node_modules/chimee-helper-utils/lib/index.flow.js
[options]
[lints]
## doc
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
### inBrowser
[src/index.js:8-10](https://github.com/Chimeejs/chimee-helper-utils/blob/bbecaf917f2d9b21704bfae1a25ebe4a10383200/src/index.js#L8-L10 "Source code on GitHub")
check if the code running in browser environment (not include worker env)
Returns **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**
### makeArray
[src/index.js:16-18](https://github.com/Chimeejs/chimee-helper-utils/blob/bbecaf917f2d9b21704bfae1a25ebe4a10383200/src/index.js#L16-L18 "Source code on GitHub")
转变一个类数组对象为数组
**Parameters**
- `obj` **any**
Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<any>**
### transObjectAttrIntoArray
[src/index.js:27-33](https://github.com/Chimeejs/chimee-helper-utils/blob/bbecaf917f2d9b21704bfae1a25ebe4a10383200/src/index.js#L27-L33 "Source code on GitHub")
sort Object attributes by function
and transfer them into array
**Parameters**
- `obj` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Object form from numric
- `fn` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** sort function (optional, default `(a,b)=>+a-+b`)
Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** the sorted attirbutes array
### runRejectableQueue
[src/index.js:39-56](https://github.com/Chimeejs/chimee-helper-utils/blob/bbecaf917f2d9b21704bfae1a25ebe4a10383200/src/index.js#L39-L56 "Source code on GitHub")
run a queue one by one.If include function reject or return false it will stop
**Parameters**
- `queue` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** the queue which we want to run one by one
- `args` **...any**
Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** tell us whether a queue run finished
### runStoppableQueue
[src/index.js:62-74](https://github.com/Chimeejs/chimee-helper-utils/blob/bbecaf917f2d9b21704bfae1a25ebe4a10383200/src/index.js#L62-L74 "Source code on GitHub")
run a queue one by one.If include function return false it will stop
**Parameters**
- `queue` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** the queue which we want to run one by one
- `args` **...any**
Returns **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** tell the user if the queue run finished
### throttle
[src/index.js:186-234](https://github.com/Chimeejs/chimee-helper-utils/blob/bbecaf917f2d9b21704bfae1a25ebe4a10383200/src/index.js#L186-L234 "Source code on GitHub")
函数节流（控制函数执行频率）
**Parameters**
- `func` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** 要节流控制的函数，必填
- `wait` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)**
- `options` **any**
- `cxt` **any**
Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** wait 等待时长
Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** options {
leading<是否首次调用立即执行，否：则按wait设定等待到期后调用才执行>:false,
trailing<是否在调用并未到期时启用定时器，以保证一定执行>:true
}
Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** cxt 上下文对象
Returns **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)**
### appendCSS
[src/index.js:278-288](https://github.com/Chimeejs/chimee-helper-utils/blob/bbecaf917f2d9b21704bfae1a25ebe4a10383200/src/index.js#L278-L288 "Source code on GitHub")
追加样式代码到head的style标签，不存在则创建
**Parameters**
- `cssText` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 样式文本
Returns **[HTMLElement](https://developer.mozilla.org/en-US/docs/Web/HTML/Element)**
### formatDate
[src/index.js:296-314](https://github.com/Chimeejs/chimee-helper-utils/blob/bbecaf917f2d9b21704bfae1a25ebe4a10383200/src/index.js#L296-L314 "Source code on GitHub")
格式化日期对象为：年-月-日 时:分:秒.毫秒
**Parameters**
- `date` **[Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)** Date日期对象 (optional, default `new Date()`)
- `pattern` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 要输出的日期格式，默认：`yyyy-MM-dd hh:mm:ss.i` (optional, default `'yyyy-MM-dd hh:mm:ss.i'`)
Returns **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
### getLocalStorage
[src/index.js:321-332](https://github.com/Chimeejs/chimee-helper-utils/blob/bbecaf917f2d9b21704bfae1a25ebe4a10383200/src/index.js#L321-L332 "Source code on GitHub")
读取本地存储的值（不支持localStorage则降级到cookie）
**Parameters**
- `key` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 目标数据key
Returns **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
### setLocalStorage
[src/index.js:339-350](https://github.com/Chimeejs/chimee-helper-utils/blob/bbecaf917f2d9b21704bfae1a25ebe4a10383200/src/index.js#L339-L350 "Source code on GitHub")
将指定key对应值写入本地存储（不支持localStorage则降级到cookie）
**Parameters**
- `key` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
- `val` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
Returns **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**