1.0.7 • Published 2 years ago

objecteye-utils v1.0.7

Weekly downloads
-
License
ISC
Repository
-
Last release
2 years ago

中科视语内部插件库

声明

  1. 此插件库仅供公司内部项目中使用
  2. 此插件库功能正在逐步优化及完善,如需使用,请关注npm更新版本,建议以最新版本为准
  3. npm地址:https://www.npmjs.com/package/objecteye-utils)
  4. version: <1.0.5>

功能描述

序号功能对应引入模块/文件
1token操作(增/删/改)auth
2页面内容与原图比例换算conversion
3用户信息加密/解密cryptoAES
4页面导出(下载)功能exportExcel
5fromdata格式formdata
6获取开始与结束时间(24小时、7天、月、年)、时间戳格式转换getDate
7表单验证validate

引用方式

  1. 单独引用

    // 按需引用 
    import {auth , conversion, cryptoAES, exportExcel, formdata, getDate, validate } from 'objecteye-utils' 
    // 直接引用对应js文件 import 对应模块 from '对应文件.js' ,以下为举例示范
    import {auth} from 'objecteye-utils/auth.js'
  1. 整体引用

    import  objecteyeUtils from 'objecteye-utils'

使用方法以及详细功能说明

  1. cookies的设置、获取、删除

    import {auth} from 'objecteye-utils'
    auth.setToken(key, value) // 添加
    auth.getToken(key) // 获取
    auth.removeToken(key) // 删除 
  2. 页面图片与图片本身尺寸的比例换算

    import {conversion} from 'objecteye-utils'
    // accDiv(param1, param2)计算比列, param1 与 param2调换顺序所得的值可以用于回显页面上显示的位置
    var ratioX = conversion.accDiv('原图宽','页面显示的图片宽'); // 计算比例宽
    var ratioX = conversion.accDiv('页面显示的图片宽','原图宽'); // 计算比例宽
    var ratioY = conversion.accDiv('原图高','页面显示的图片高'); // 计算比例高
    var ratioY = conversion.accDiv('页面显示的图片高','原图高'); // 计算比例高
    // accMul(ratioX, numX) accMul(ratioY, numY) 根据比例计算应该在原图上的显示位置
    var originX = conversion.accMul('比例宽值', 'x')
    var originY = conversion.accMul('比例高值', 'y')
  3. 信息加密以及解密

    import {cryptoAES} from 'objecteye-utils'
    var str = cryptoAES.encrypt('12345') // 加密, 返回内容为加密后的字符串
    var originStr = cryptoAES.decrypt('加密后的字符串') // 解密, 返回内容为加密前的字符串
  4. 导出文件(基于axios封装)

    import {exportExcel} from 'objecteye-utils'
    exportExcel({
        type: 'post', // 请求方式,参数get/post 默认为post
        url: '/export/excel', // 请求路径
        authToken: '', // 请求头携带token
        data: {}, // 请求参数,具体内容根据接口文档来写
        fileFormat: 'excel' // 导出的文件格式 excel/zip等
    })
  5. 对象转为formdata格式数据

    import {formdata}  from 'objecteye-utils'
    formdata(data) // data为Object  
    formdata({
        'key1': 1,
        'key2': 2
    })
  6. 获取各种时间以及时间戳转换

    import {getDate}  from 'objecteye-utils'
    // 以下方法返回内容为对象 {startTime: '', endTime: ''}
    var today = getDate.today()  // 获取当天0点-当前时间的时间戳
    var yesterday = getDate.yesterday() //昨天00:00-23:59:59的时间戳
    var week = getDate.week() // 昨天00:00-23:59:59的时间戳
    var month = getDate.month() // 昨天00:00-23:59:59的时间戳
    var twentyFourHours = getDate.TwentyFourHours() // 昨天00:00-23:59:59的时间戳
    // 时间戳转为'YYYY-MM-DD HH:MM:SS'
    var currentTime = getDate.formatTime()
  7. 正则验证字符串格式

    import {validate}  from 'objecteye-utils'
    // 以下方法返回内容均为Boolean,  true|false
    validate.isExternal(path) // 验证path是否为外部链接
    validate.validURL(url) // 验证地址url是否符合规范
    validate.validLowerCase(str) // 验证字符串是否均为小写
    validate.validUpperCase(str) // 验证字符串是否均为大写
    validate.validAlphabets(str) // 验证字符串是否均为字母
    validate.validEmail(email) // 验证邮箱地址格式是否正确
    validate.validPhoneNumber(phoneNumber) // 验证手机号格式是否正确
    validate.isImage(imgStr) // 验证图片格式

插件库开发成员注意事项

  1. 每次更新后的版本请将更新内容、更新人标注在日志中
  2. 更新内容上传至插件所在的git上
  3. 如有问题及时反馈,共同维护
  4. 请按照规范书写readme文档

版本号说明

  1. 版本号规范主版本号.次版本号.增强版本号.里程碑版本号
  2. 主版本号:项目的重大重构
  3. 次版本号:新功能的添加和变化
  4. 增强版本号: BUG的修复

更新日志(从版本:1.0.5开始)

  • 2023.01.16 更新优化代码,确认初始版本(1.0.5),编写readme.md
  • 2023.01.30 优化readme.md内容,版本号:1.0.7

1.0.7

2 years ago

1.0.6

2 years ago

1.0.5

2 years ago

1.0.4

2 years ago

1.0.3

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago