Skip to content

提取的一些常用工具方法,包括:Axios二次封装、基础方法等

License

Notifications You must be signed in to change notification settings

idinofe/xt-core

Repository files navigation

提取的一些常用工具方法,包括:Axios二次封装、基础方法等。

npm (scoped) npm GitHub contributors

🚀 特性

  • 🎪在线文档和 demo
  • 🌎无编译器场景:可直接使用 CDN 版本
  • 🦾类型支持良好:使用 TypeScriptTS Docs 编写
  • ⚡摇树优化:按功能模块定义导出可通过按需引入模块减少打包体积,支持 5 大模块:common http url web wechat

📦 安装

npm i @dinofe/xt-core

示例

CDN

<script src="https://unpkg.com/@dinofe/xt-core@next/dist/umd/xt-core.min.js"></script>

引入此脚本之后,所有 API 都会挂载到 widnow.XtCore 上。

🦄 使用

支持按需引入各模块自己的 API

wechat 模块引入 genOAuthUrl 方法:

import { genOAuthUrl } from '@dinofe/xt-core/wechat'

const wechatOptions = {
  wx_appid: '123456',
  wx_component_appid: '1123456',
  wx_scope: 'snsapi_base',
  redirect_url: 'https://www.github.com',
  state: '0'
}
const url = genOAuthUrl(wechatOptions)
console.log(url)

5 大模块导出的所有 API 都可以直接引入

直接导引入 genOAuthUrl 方法:

import { genOAuthUrl } from '@dinofe/xt-core'
// ... 用法和上面相同

支持的方法列表请查看 API 文档

🧱 参与贡献

脚本命令
  1. 启动项目
npm run vitest

或者

npm run vitest:ui
  1. 构建打包
npm run build
  1. 预览文档

编译项目,生成类型声明

npm run docs:build

启动文档本地预览

cd ./tsdoc
npm run docs:dev

说明:如果源码有变更需要手动重新执行 npm run docs:build

  1. 发布测试包(预发布)
npm run releaseit

需要先切换到npm官方源、并登录账号

使用预览版

预览版使用 next tag 发布,安装命令如下:

npm i @dinofe/xt-core@next

📄 开源协议

MIT License