ufin-secrets v0.0.1-beta.1

ufin-secrets

优飞数科前端加密工具库

目的：整合业务中常用地加解密方法，进行统一管理

为避免不同项目多次复制粘贴的麻烦，这里统一封装，并发布到 npm，以提高开发效率。

目录介绍

.
├── build 脚本
├── libs 编译产出代码
├── docs 项目文档
├── src 源代码目录
├── tests 单元测试

安装使用

npm:

$ npm install ufin-secrets -S

1. 完整使用

// 完整引入
const { md5 } = require('ufin-secrets');
const result = md5('加密内容');

2. 推荐使用方法

依赖加载

import { md5 } from 'ufin-secrets';
const result = md5('加密内容');

API 文档

文档地址

方法

md5

sm2

贡献指南

首次运行需要先安装依赖

$ yarn install

添加测试用例

在 在每一个方法文件夹下建一个 __test__/*.spec.ts 添加相应的测试用例文件

打包生成生产代码

$ npm run build

运行单元测试，浏览器环境需要手动测试，位于test/browser

$ npm test

生成文档

$ npm run gen:docs