chimee-helper-utils

    0.2.1 • Public • Published

    chimee-helper-utils

    Build Status Coverage Status npm dependency Status devDependency Status

    utils of chimee

    get started

    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

    inBrowser

    src/index.js:8-10

    check if the code running in browser environment (not include worker env)

    Returns Boolean

    makeArray

    src/index.js:16-18

    转变一个类数组对象为数组

    Parameters

    • obj any

    Returns Array<any>

    transObjectAttrIntoArray

    src/index.js:27-33

    sort Object attributes by function and transfer them into array

    Parameters

    • obj Object Object form from numric
    • fn Function sort function (optional, default (a,b)=>+a-+b)

    Returns Array the sorted attirbutes array

    runRejectableQueue

    src/index.js:39-56

    run a queue one by one.If include function reject or return false it will stop

    Parameters

    • queue Array the queue which we want to run one by one
    • args ...any

    Returns Promise tell us whether a queue run finished

    runStoppableQueue

    src/index.js:62-74

    run a queue one by one.If include function return false it will stop

    Parameters

    • queue Array the queue which we want to run one by one
    • args ...any

    Returns boolean tell the user if the queue run finished

    throttle

    src/index.js:186-234

    函数节流(控制函数执行频率)

    Parameters

    • func Function 要节流控制的函数,必填
    • wait number
    • options any
    • cxt any

    Returns Number wait 等待时长

    Returns Object options { leading<是否首次调用立即执行,否:则按wait设定等待到期后调用才执行>:false, trailing<是否在调用并未到期时启用定时器,以保证一定执行>:true }

    Returns Object cxt 上下文对象

    Returns Function

    appendCSS

    src/index.js:278-288

    追加样式代码到head的style标签,不存在则创建

    Parameters

    Returns HTMLElement

    formatDate

    src/index.js:296-314

    格式化日期对象为:年-月-日 时:分:秒.毫秒

    Parameters

    • date Date Date日期对象 (optional, default new Date())
    • pattern String 要输出的日期格式,默认:yyyy-MM-dd hh:mm:ss.i (optional, default 'yyyy-MM-dd hh:mm:ss.i')

    Returns String

    getLocalStorage

    src/index.js:321-332

    读取本地存储的值(不支持localStorage则降级到cookie)

    Parameters

    Returns String

    setLocalStorage

    src/index.js:339-350

    将指定key对应值写入本地存储(不支持localStorage则降级到cookie)

    Parameters

    Returns String

    Install

    npm i chimee-helper-utils

    DownloadsWeekly Downloads

    211

    Version

    0.2.1

    License

    MIT

    Last publish

    Collaborators

    • welefen
    • songguangyu
    • yandeqiang
    • huzunjie
    • toxicjohann
    • gaoyiyi