https://github.com/hyhello/utils

《常用前端工具函数库》已完结~
https://github.com/hyhello/utils

browser nodejs tools utils utils-library

Last synced: about 1 month ago
JSON representation

《常用前端工具函数库》已完结~

• Host: GitHub
• URL: https://github.com/hyhello/utils
• Owner: Hyhello
• License: mit
• Created: 2021-11-09T06:34:53.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2024-05-22T13:27:21.000Z (8 months ago)
• Last Synced: 2024-05-22T13:41:08.400Z (8 months ago)
• Topics: browser, nodejs, tools, utils, utils-library
• Language: TypeScript
• Homepage: https://Hyhello.github.io/utils/
• Size: 1.06 MB
• Stars: 8
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# @hyhello/utils

[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/toss/slash/blob/main/LICENSE) [![codecov](https://codecov.io/github/Hyhello/utils/graph/badge.svg?token=85BP7240GO)](https://codecov.io/github/Hyhello/utils) [![NPM badge](https://img.shields.io/npm/v/%40hyhello%2Futils?logo=npm)](https://www.npmjs.com/package/@hyhello/utils)

### 介绍

前端常用工具函数库。[查看在线文档](https://hyhello.github.io/utils/#/)

### 安装教程

```javascript

npm install @hyhello/utils

```

Note: add --save if you are using npm < 5.0.0

### 使用说明

Use in a browser(CDN):

```javascript

or

```

Use In Node.js:

```javascript

// Load the full build.

var utils = require('@hyhello/utils');

// Load method categories.

var isArray = require('@hyhello/utils/lib/isArray');

or

var { isArray } = require('@hyhello/utils');

```

Use In ES6:

```javascript

// Load the full build.

import utils from '@hyhello/utils';

// Load method categories.

import isArray from '@hyhello/utils/lib/isArray';

or

import { isArray } from '@hyhello/utils';

```

### 按需引入

> [!TIP]

> 从 `V1.12.0` 版本开始，如果您使用的构建工具支持 `Tree shaking`，您在使用 `@hyhello/utils` 库时将能够实现按需加载，无需进行任何额外配置。

#### Usage in babel

```javascript

npm install babel-plugin-import --save-dev

```

Via .babelrc or babel-loader.

```javascript

{

  "plugins": [["import", options]]

}

```

options can be object.

```javascript

{

  "libraryName": "@hyhello/utils",

  "camel2DashComponentName": false,  // default: true

}

```

#### Usage in vite

```javascript

npm install vite-plugin-imp --save-dev

```

Via vite.config.js.

```javascript

import vitePluginImp from 'vite-plugin-img';

export default defineConfig({

    plugins: [vitePluginImp(options)]

});

```

options can be object.

```javascript

{

  "libName": "@hyhello/utils",

  "libDirectory": "lib",

  "camel2DashComponentName": false

}

```

#### For example, the default behavior

```javascript

import { isArray } from '@hyhello/utils';

↓ ↓ ↓ ↓ ↓ ↓

var isArray = require('@hyhello/utils/lib/isArray');

```

### 支持情况

Tested in Chrome 74-75, Firefox 66-67, IE 9, Edge 18, Safari 11-12.

注：采用 jest + jsdom 进行单元测试，报告如下：

- Statements：98.96%

- Branches：97.22%

- Functions: 99.28%

- Lines: 99.02%