cmn-utils


可复用的通用模块, 一些不常用的函数，或在全局函数里会引起奇异的函数没有引出到全局，可以使用$$.request | $$.store 等间接使用，或import { request } from 'cmn-utils'，也可以直接使用 import request from 'cmn-utils/lib/request'

目录

* Request 详细
* Store 详细
* Event
* UI
* Utils
* Download

Request

简单包装的Fetch

API

- requestConfig 配置所有默认选项
- requestHeaders 设置headers, 支持 object | key-value | function 类型参数
- send 发送请求
- getform, postform, get, post, head, del, put 发送请求(这些都是简化的send)
- 支持jsonp
- 下面为不在$$中的方法
- create 返回新实例
- config 同 requestConfig
- headers 同 requestHeaders
- prefix 设置请求前缀，可在config中设置
- beforeRequest 请求前hook
- afterResponse 响应后hook
- contentType 设置content-type

使用

``javascript
import $$ from 'cmn-utils';

// 发送请求
$$.send('/send')
$$.get('/get/1')
$$.post('/post')
$$.put('/put')
$$.del('/put/1')
$$.jsonp('abc.jsonp').then(resp => resp.json())
`
#### 默认选项
`
{
method: 'POST', // default 'POST'
mode: 'cors',
cache: 'no-cache',
credentials: 'include',
headers: {
'content-type': 'application/json'
},
responseType: 'json', // text or blob or formData https://fetch.spec.whatwg.org/
prefix: '', // request prefix
beforeRequest: null, // before request check, return false or a rejected Promise will stop request
afterResponse: null, // after request hook
timeout: null, // request timeout (ms)
}
`

$3

#### 简化写法

`javascript
// 原始fetch 写法
fetch('http://httpbin.org/post', {
method: 'POST',
headers: {
'content-type': 'application/json'
},
body: JSON.stringify({
name: 'weiq',
})
})
.then(function(response) {
if (response.status >= 200 && response.status < 300) {
return response.json()
}
throw new Error(response.statusText)
})
.then(function(json) {
// ...
})

// 等价于，直接使用send方法
$$.send('http://httpbin.org/post', {
method: 'POST',
data: {name: 'weiq'}
}).then(resp => {
console.log(resp.json) // {name: 'weiq'}
})

// 等价于，使用提供的post方法
$$.post('http://httpbin.org/post', {name: 'weiq'})
.then(resp => {
console.log(resp.json) // {name: 'weiq'}
})
`

#### 提交form表单

`js
// 提交form表单
$$.getform('/form', {name: 'weiq'}) // 将拼接到url后面
//.postform('/form', {name: 'weiq'}) // 将做为Form Data发送
.then(resp => {
console.log(resp.json) // {name: 'weiq'}
})
`

#### 使用FormData && 上传
`html

Upload FormData

`
注：不能用get方法
`js
const data = new FormData();
data.append('file', document.querySelector('#avatar').files[0]);
data.append('user', 'weiq');

$$.post('http://httpbin.org/post', data)
.catch(e => console.error('upload error!', e));
`

#### 全局配置, 将会覆盖默认参数, 一般全局配置一次

`js
// 全局配置, 将会覆盖默认参数, 一般全局配置一次
$$.requestConfig('method', 'GET')
.requestConfig({
headers: {'content-type': 'application/json'},
prefix: '/api'
})
// 配置请求头
$$.requestHeaders('Accept', 'application/json') // key-value
.requestHeaders({ Accept: 'application/json' }) // json

// 用函数反回头
$$.requestHeaders(_ => ({
random: Math.random()
}))
`

#### 临时改变配置项

`js
$$.post('http://httpbin.org/post', {name: 'weiq'}, {
headers: {
'content-type': 'application/json'
},
responseType: 'json', // 转成json
})
.then(resp => {
console.log(resp.json) // {name: 'weiq'}
})
`

#### 获取原始响应结果 & 单独处理响应

当返回值不是统一格式时，使用afterResponse: null,可以不走全局的拦截器，或者想取原始响应结果时使用responseType: null

`js
$$.get("http://httpbin.org/get", {}, {
responseType: null, // 不处理返回结果
afterResponse: null // 不走公共 afterResponse
})
.then(function(resp) {
console.log(resp)
})
.catch(e => console.log(e));
`

#### 并发请求

`js
function concurrencyRequest() {
let r1 = $$.get("http://httpbin.org/get");
let r2 = $$.post("http://httpbin.org/post");
let r3 = $$.put("http://httpbin.org/put");

Promise.all([r1, r2, r3])
}
`

Store

简单包装的store2

API

- setStore
- getStore
- removeStore
- clearStore
- 下面为不在$$中的方法
- getStoreAsync
- create
- getStoreInfo
- getStoreInfoAsync
- session
- local

`javascript
$$.setStore("name", "abc")
.setStore("multi", {ip: '0.0.0.0'})
.setStore("age", 18)
.setStore({
a: 1,
b: 2,
c: true
})
$$.getStore("multi");

$$.removeStore('name')

$$.clearStore()

$$.store.getStoreAsync("name").then(value => console.log("async:", value));

$$.store.getStoreInfo();

$$.store
.getStoreInfoAsync(value => console.log(value))
.setStore('name', 'abc');

$$.store.session('name', 'abc'); // 存储到 sessionStorage中
$$.store.local('name', 'abc'); // 存储到 localStorage中
`

Event

让组件可以发射、监听自定义事件, 有时我们可能需要让两个没有太大关系的组件间建立联系，比如增加商品到购物车这个场景，一般会在页面头部（Header组件）放置购物车的图标，商品列表（Goods组件）中有一个添加到购物车的图标，我们想点击这个图标时，让头部购物车图标显示+1的效果，有几种方案，其一是在头部定义一个changeCardNumber方法，然后把这个方法层层传递到商品列表（Goods）中，进行调用，这很容易出错，其二是点击商品列表中商品时，通过dispatch发出一个类型是changeCardNumber的action，这种方法我们不得不把Header包装一下才可以让它处理dispatch的能力, 最后如果我们用自定义事件可以更容易实现这个效果，即在Header中订阅一个changeCardNumber这个事件，在其它任何地方只有触发trigger这个事件就可以了，只需要注意不用的事件要及时移除。

API

- on 注册事件监听
- off 移除事件监听
- once 注册一次事件监听，只能触发一次trigger触发后即自动从监听中移除
- trigger 触发事件

#### 示例

`javascript
$$.on('eventName', function(value) {
console.log(value)
});

$$.trigger('eventName');

$$.off('eventName');

$$.once('eventName', function(value) {
console.log(value)
});
`

Download

下载文件 $$.download(data, strFileName, strMimeType);

#### 示例
`javascript
$$.download("hello world", "dlText.txt", "text/plain");

$$.download("data:text/plain,hello%20world", "dlDataUrlText.txt", "text/plain");

$$.download(new Blob(["hello world"]), "dlTextBlob.txt", "text/plain");

$$.download("/robots.txt");

var str= "hello world", arr= new Uint8Array(str.length);
str.split("").forEach(function(a,b){
arr[b]=a.charCodeAt();
});
$$.download( arr, "textUInt8Array.txt", "text/plain" );

$$.download("/diff6.png");

var x=new XMLHttpRequest();
x.open( "GET", "/diff6.png" , true);
x.responseType="blob";
x.onload= function(e){
$$.download(e.target.response, "awesomesauce.png", "image/png");
};
x.send();
``