# @yangguoxin/fin-request

> xmlhttprequest封装，支持h5签名

Latest version **2.0.15** (published 2021-07-13) · ISC license · 0 weekly downloads

## Install

```sh
npm install @yangguoxin/fin-request
pnpm add @yangguoxin/fin-request
yarn add @yangguoxin/fin-request
bun add @yangguoxin/fin-request
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.15 |
| Published | 2021-07-13 |
| First published | 2021-07-13 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 99.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jonathan Wang |
| Maintainers | ygx763123 |

## Links

- npm: https://www.npmjs.com/package/@yangguoxin/fin-request
- Repository: http://git.blackfi.sh/scm/~jonathanwang/fin-request
- npm.io page: https://npm.io/package/@yangguoxin/fin-request

## Dependencies (3)

- [js-base64](https://npm.io/package/js-base64.md) ^2.4.9
- [blueimp-md5](https://npm.io/package/blueimp-md5.md) ^2.10.0
- [@yangguoxin/mini-shim](https://npm.io/package/@yangguoxin/mini-shim.md) ^1.0.1

## Recent versions

- 2.0.15 (latest) — 2021-07-13
- 1.0.0 — 2021-07-13

## README

# fin-request

支持`基础参数`，`h5加签`，`base64`的ajax库

## 安装

*安装前，请确保已经切换到[小黑鱼NPM](http://wiki.blackfi.sh/pages/viewpage.action?pageId=9195584)*

```bash
$ npm install @blackfish/fin-request --save
```

## 使用

例如：
```js
import { request } from '@blackfish/fin-request'
// ...
request({
  url: 'https://api.XXX.com',
  method: 'POST',
  merge: true, // 采用合并方式
  sign: true, // 生成签名
  data: {
    baseParams: {pValue},
    bizParams: data
  }
}).then(res => successHandle(res)) // 成功处理
  .catch(error => errorHandle(error)) // 失败处理
```

## 参数说明

参数 | 默认值 | 说明 
------- | ------- | --------
url | '' | 请求地址
method | 'GET' | 请求方式
async | true | 是否异步
data | null | 请求参数
contentType | 'text/plain;charset=UTF-8' | 
dataType | 'json' | response数据类型，可选'text'
timeout | 30000 | 超时时间
withBase | false | 追加基础参数
merge | false | 和基础参数做合并，用于修改基础参数，withBase=false 生效
sign | false | 是否生成签名
debug | false | 是否走测试环境

## 单独使用签名函数

如果你只想单独使用签名功能，可以参考如下例子

```js
import { sign } from '@blackfish/fin-request'

let data = { // 请求入参
  baseParams: {
    // ...
  },
  bizParams: {
    // ...
  },
  timestamp: '1525952105841' // 请求时间戳
}
// 加签
sign(data) // sign(data, true) 走测试环境拿盐值
// data 已增加签名字段
console.log(data)

// { // 请求入参
//   baseParams: {
//     // ...
//   },
//   bizParams: {
//     // ...
//   },
//   sign: XXXXXXXXXXXXXXXX,
//   timestamp: '1525952105841' // 请求时间戳
// }
```

## 单独使用基础参数

```js
import { getDefaultParams } from '@blackfish/fin-request'
```
## url query 参数
### bf_ai
appId 通过url形式设置，用于在app外的页面需要设置appId的情况。

[appId枚举](http://wiki.blackfi.sh/pages/viewpage.action?pageId=26174854)

## 说明
为了更符合现代框架，减小包的体积，最新打包>=2.0.0的打包已经不将es6的polyfil打包进入库中，需要业务项目单独引入`babel-polyfill`。或者babel-loader include本库进行`transform-runtime`

## 更新日志

### v2.0.7
- ios baseParams 不能覆盖问题

### v2.0.6
- stringify 循环引用报错

### v2.0.5
- deviceIdXhy 新增字段

### v2.0.4
- ajax 请求error 返回
- 风控设备指纹区分环境

### v2.0.3
- 基础参数添加风控设备指纹

### v2.0.2
- 采用mini-shim 判断是否小程序环境

---
_Source: https://npm.io/package/@yangguoxin/fin-request · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
