https://github.com/censujiang/galanga
JS common function library
https://github.com/censujiang/galanga
javascript js js-lib js-library jslibrary library ts typescript
Last synced: 12 months ago
JSON representation
JS common function library
- Host: GitHub
- URL: https://github.com/censujiang/galanga
- Owner: censujiang
- License: apache-2.0
- Created: 2023-01-31T10:50:28.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-06-04T14:26:47.000Z (about 2 years ago)
- Last Synced: 2025-05-09T15:53:27.774Z (about 1 year ago)
- Topics: javascript, js, js-lib, js-library, jslibrary, library, ts, typescript
- Language: JavaScript
- Homepage: https://galanga.censujiang.com
- Size: 2.26 MB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [山奈Galanga](https://github.com/censujiang/galanga)
开源好用的 `JS|TS` 常用函数库
[官方文档](https://galanga.censujiang.com) | [中国镜像](https://galanga.censujiang.cn)
## :star: 简介
山奈/Galanga（以下简称山奈）是川菜中常用的调味品，也可以用作腌制成为单独的菜品，而这一辅料被人们俗称为姜。
在Web的世界里，它是一个开源的实用的JS函数库，它的目标是提供一些常用的函数，让你的代码更简洁更易读。我们希望利用姜来让您的代码更加美味，让您更加专注于业务逻辑的实现。
- 使用ES6+和TypeScript编写源码，编译生成生产代码
- 多环境支持（支持浏览器原生，支持AMD，CMD，支持Webpack，Rollup，fis等，支持Node）
- 无依赖，体积小巧
## :pill: 兼容性
单元测试保证支持如下环境：
| IE | CH | FF | SF | OP | IOS | Android | Node |
| ---- | ---- | ---- | ---- | ---- | ---- | ---- | ----- |
| 6+ | 29+ | 55+ | 9+ | 50+ | 9+ | 4+ | 4+ |
**注意：编译代码依赖ES5环境，对于ie6-8需要引入[es5-shim](http://github.com/es-shims/es5-shim/)才可以兼容，可以查看[demo/demo-global.html](./demo/demo-global.html)中的例子**
## :open_file_folder: 目录介绍
```
.
├── config 打包配置文件
├── demo 使用demo
├── dist 编译产出代码
├── docs 项目文档站点
├── scripts 打包脚本
├── src 源代码目录
├── test 单元测试
├── wiki 项目文档源代码
```
## :rocket: 使用者指南
通过npm下载安装代码
```bash
npm install --save galanga
```
如果你是node环境
```js
var base = require('galanga');
```
如果你是webpack、vite等环境
```js
import base from 'galanga';
```
如果你是requirejs环境
```js
requirejs(['node_modules/galanga/dist/index.aio.js'], function (base) {
// xxx
})
```
如果你是浏览器环境
```html
```
更多安装及使用方法请查看[INSTALL.md](./wiki/guide/install.md)
## :kissing_heart: 贡献者指南
[CONTRIBUTING.md](./wiki/guide/contribute.md)
[](https://github.com/censujiang/galanga/graphs/contributors)
## :gear: 更新日志
[CHANGELOG.md](./wiki/guide/changelog.md)
## :airplane: 计划列表
[TODO.md](./wiki/guide/todo.md)