0.1.5 • Published 4 years ago
@imvkmark/poppy-js-util v0.1.5
poppy-js-util
Poppy Framework Js Util Packages
:rocket: 使用者指南
通过npm下载安装代码
$ npm install --save @imvkmark/poppy-js-util
如果你是node环境
var poppyjs = require('@imvkmark/poppy-js-util');
如果你是webpack等环境
import {isMobile} from '@imvkmark/poppy-js-util';
如果你是requirejs环境
requirejs(['node_modules/@imvkmark/poppy-js-util/dist/index.aio.js'], function (base) {
// xxx
})
如果你是浏览器环境
<script src="node_modules/@imvkmark/poppy-js-util/dist/index.aio.js"></script>
:bookmark_tabs: 文档
api模版
函数简单介绍
函数详细介绍
函数参数和返回值(要遵守下面的例子的规则)
- param {string} name1 name1描述
- param {number} name2 name2描述 ([]代表可选参数)
- param {string|number} name3 name3描述 (| 代表多种类型)
- param { } name3 name3描述 (代表任意类型)
- param {boolean} obj.sex 复合参数定义
- return {string} 返回值描述
举个例子(要包含代码用例)
// 代码
特殊说明,比如特殊情况下会报错等
:kissing_heart: 贡献者指南
首次运行需要先安装依赖
$ npm install
一键打包生成生产代码
$ npm run build
运行单元测试:
$ npm test
注意:浏览器环境需要手动测试,位于
test/browser
修改 package.json 中的版本号,修改 README.md 中的版本号,修改 CHANGELOG.md,然后发布新版
$ npm run release
将新版本发布到npm
$ npm publish
贡献者列表
:gear: 更新日志
0.2.0 / 2019-3-1
- 新增功能C
- 新增功能D
0.1.0 / 2018-3-1
- 新增功能A
- 新增功能B