1.0.2 • Published 4 years ago
@ysfe/signature v1.0.2
@ysfe/signature
前端签名生成工具
前置依赖
略
开发指引
使用方式
- 安装: 执行
yarn add @ysfe/signature 使用:
- 详细请参考测试用例: 传送门
- 简单使用
const res = signature({ data: { // your params } }).toString()
参数说明
参数及用法, 请看
./src或 单测用例
| 参数 | 描述 | 类型 | 默认值 | 其他说明 | |||
|---|---|---|---|---|---|---|---|
| data | 请求参数 | {key:string:any} | {} | ||||
| suffix | 自定义后缀 （参数盐值） | string | 无 | ||||
| sort | 是否启用排序 or 自定义排序方法 | boolean / (key1:string, key2:string)=> number / false | |||||
| hashFactory | 签名 hash 计算方法 | 'MD5' | 'SHA1' | 'SHA256' | (str:string)=>string | MD5 |
导出事件
参数及用法, 请看
./src或 单测用例
| 方法 | 描述 |
|---|---|
| serialize | 参数序列化, 生成 query 字符串 |
| toString | 输出签名字符串 |
| addToUrl | 将参数携带签名附加给 url |
二次抽象方法 | signByStr
- 描述: 解析 url 串, 并生成签名
- 参数/示例:
const res = signByStr(
'http://test.com/',
{ a: '123', c: '234' },
{ sort: true }
)实现方案
略
注意事项
- 注意参数序列化方式里面, 数组参数序列化方式为
arrayFormat: 'brackets', 如果出现问题, 变更这里或提前进行 stringify 即可
版本说明
- 2021-06-08 | 完成工具抽象