Vlsdk NPM | npm.io

vlSDK 使用文档

安装

npm install vlsdk

引用

var vlSDK = require('vlsdk')
// 或es6
import vlSDK from 'vlsdk'
// 本地也可以直接将 dist/vlSDK.js 或 vlSDK.min.js 拷贝到本地使用

配置

vlSDK.config({
  // 必填 系统申请的Key
  appKey: '888888',  
  // 不稳定参数，仅开供开发调试用, 默认prod，可选参数： dev, test, stag, prod
  __env: 'test',  
  // 是否app内环境 默认为false
  internal: true, 
  // 是否缓存请求数据 默认false,
  cache: true, 
  //百度地图申请key，选填 若不需要可为空 则不适用百度地图错误纠正位置数据
  BMap: { 
    ak: key,
    v: '2.0'
  }
})

数据请求

Promise 形式

  vlSDK.fetch({
    // 必填 vid
    vid: '0x****',
    // 选填，默认全部 可选['trackinfo', 'skuinfo', 'enbaseinfo', 'activityinfo']
    fields: ['trackinfo'] 
    // 选填，若App内验真使用
    token: '223344' 
  }).then(function(res){
    console.log(res, 333)
  }).catch(function(res){
    console.log(res, 444)
  })

回调形式

  vlSDK({
   params: {
    // 必填 vid
    vid: '0x****',
    // 选填，默认全部 可选['trackinfo', 'skuinfo', 'enbaseinfo', 'activityinfo']
    fields: ['trackinfo'] 
    // 选填，若App内验真使用
    token: '223344' 
   },
   // 成功回调
   success: function(res){
     console.log(res, 555)
   },
   // 请求失败回调
   fail: function(res){
     console.log(res, 666)
   },
   // 无论成功失败都回调
   callback: function(res){

   }
 })

扩展方法

// 查看当前版本号
vlSDK.version

// 清除vid数据缓存
vlSDK.clearCache() 

// 清除本域名下所有缓存
vlSDK.clearAll() 

// 可用于数据按需加载，返回promise
vlSDK.again(option)

NOTE: again中option 可接受参数为Null, String, Array, Object Null: 按之前参数请求; String: vid 值; Array: fields (可选：'trackinfo', 'skuinfo', 'enbaseinfo', 'activityinfo'); Object: {vid: vid, fields: []}