# sunny-js

![npm version](https://img.shields.io/npm/v/sunny-js)
![npm downloads](https://img.shields.io/npm/dm/sunny-js)
![license](https://img.shields.io/npm/l/sunny-js)

这个一个工具函数库。

## Installation

使用npm安装

```shell
npm i sunny-js
```

使用yarn安装

```shell
yarn add sunny-js
```

使用pnpm安装

```shell
pnpm add sunny-js
```

## Usages

cjs

```js
const { sum } = require('sunny-js')
console.log(sum([1, 2]))
// => 3
```

esm

```ts
import { sum } from 'sunny-js'
console.log(sum([1, 2]))
// => 3
```

更多用例均分布在jsdoc风格的代码注释中，使用时可被IDE读取并展示。

或者借助typedoc生成html文档

```shell
npx --yes typedoc --out typedoc --categorizeByGroup false --entryPoints src
npx --yes open-cli typedoc/index.html
```

## Motivation

在ECMAScript定义的函数或lodash无法满足常规需求的情况下，我创建了这个工具函数库。
用来积累日常工作中不太变动、经常出现、且需要避免到处复制粘贴的工具函数。

## Browser Compatibility

![浏览器兼容性](https://img.shields.io/badge/browserslist-Android%20%3E%3D%205%2CiOS%20%3E%3D%2010-informational)

## Changelog

See [CHANGELOG.md](CHANGELOG.md)