ts-bigscreen-vue/node_modules/utils-lite/README.md

230 lines
2.8 KiB
Markdown

![download](https://img.shields.io/npm/dm/utils-lite.svg)
![version](https://img.shields.io/npm/v/utils-lite.svg)
![npm bundle size (minified)](https://img.shields.io/bundlephobia/min/utils-lite.svg)
![language](https://img.shields.io/badge/language-javascript-yellow.svg)
![License](https://img.shields.io/badge/license-MIT-000000.svg)
## Install
`npm i utils-lite -S`
## Start JS
#### use npm
```js
import { debounce } from 'utils-lite'
// commonjs package is 'utils-lite/lib/index.cjs.js'
debounce(() => {
// code...
}, 1000)
```
#### use cdn
```html
<script src="https://unpkg.com/utils-lite/lib/index.umd.min.js"></script>
<script>
UtilsLite.debounce(function () {
// code ...
}, 1000)
</script>
```
## Start CSS
Now css utils package has three file type: less, sass, stylus as `index.less`/
`index.sass`/`index.styl`, you can choose one and import to you project, for example
```less
@import 'project-path/node_modules/utils-lite/index.less';
.test {
.text-ellipsis
}
```
```less
@import 'project-path/node_modules/utils-lite/index.sass';
.test {
@include text-ellipsis;
}
```
```less
@import 'project-path/node_modules/utils-lite/index.styl';
.test
text-ellipsis();
```
## JS Utils List
### debounce
```js
debounce(<fn>, <delay>)
```
### throttle
```js
throttle(<fn>, <wait>, [delay])
```
### get
```js
get(<target>, <path>, [default])
```
> path format: 'a.b.c'
### set
```js
set(<target>, <path>, <value>)
```
### clone
```js
clone(<target>)
```
### cloneDeep
```js
cloneDeep(<target>)
```
### getType
```js
getType(<target>)
```
### getTypeof
```js
getTypeof(<target>)
```
### isObject
```js
isObject(<target>)
```
### isArray
```js
isArray(<target>)
```
### isFunction
```js
isFunction(<target>)
```
### isString
```js
isString(<target>)
```
### isBoolean
```js
isBoolean(<target>)
```
### isEmptyObj
```js
isEmptyObj(<target>)
```
### isNumber
```js
isNumber(<target>)
```
### getStore
```js
getStore(<key>)
```
### setStore
```js
setStore(<key>, <value>)
```
### kebabToCamel
```js
kebabToCamel(<key>)
```
### camelToKebab
```js
camelToKebab(<key>)
```
### unique
```js
unique(<array>)
```
### getLinearValue
```js
getLinearValue(<x1>, <y1>, <x2>, <y2>, [x3])
```
### getFnAndObjValue
```js
getFnAndObjValue(<function|object>, <key>)
```
### arrDelItem
```js
arrDelItem(<array>, <diffItem>)
```
### arrDelArrItem
```js
arrDelArrItem(<array>, <diffArrayItem>)
```
### toArray
```js
toArray(<arrayLike>)
```
### getArrayMin
```js
getArrayMin(<array>)
```
### extend
```js
extend(<sourceObj>, [otherObj])
```
### hasOwn
```js
hasOwn(<target>)
```
### isEqual
```js
isEqual(<alice>, <bob>)
```
## CSS Utils List
### text-ellipsis
```less
.target {
.text-ellipsis
}
```
### text-loading
```less
.target {
.text-loading([time])
}
```
## License
MIT