# 使用指南
# 安装
npm i @dinofe/xt-core
# 使用
# 1.直接引入需要的方法
所有支持的方法请查看 API 列表
import { isDef, isString } from '@dinofe/xt-core'
const name = 'foo'
console.log(isDef(name), isString(name))
# 2.分模块引入需要的方法
这引入方法可以让编译工具有效地进行摇树优化 (opens new window),以减少此包最终打包输出占用的体积。
提示
此方法需要你的编译工具支持条件导入 (opens new window),webpack、rollup、esbuild、vite、Node.js 等对条件导入的支持情况不尽相同,请查看各自文档。
import { isDef, isString } from '@dinofe/xt-core/common'
const name = 'foo'
console.log(isDef(name), isString(name))
example (opens new window) 目录中有不同项目架子的引入写法,可以对比查看你的项目是否也支持分模块引入需要的方法,如有不清楚的地方,欢迎提交 issue (opens new window) 讨论。
# 3.CDN引入
将下面 script 标签插入到 HTML 页面。
<script src="https://unpkg.com/@dinofe/xt-core@latest/dist/umd/xt-core.min.js"></script>
替换
latest
为对应的版本号或者next
可引入不同版本
之后所有导出的 API 都挂载到 window.XtCore
上。
window.XtCore.isDef('aaa')
提示
这种方式将依赖的第三方包都内置到了 UMD 模块中,像 axios
这些无需再通过 script 引入,不过有些第三方包在重复引入时会有问题,请谨慎使用此模式。
# 参与贡献
对于包的使用者可以忽略这一步骤,对于本项目的开发者,请查看 参与贡献。