@abramstyle/kl-utils 中文文档教程
kl-utils
用于操作对象、数组和其他数据类型的轻量级 javascript 实用程序。
Usage
import {objectUtils} from '@kl/utils';
objectUtils.isObject({a: 1});
Types
default
isSameType(item, otherItem)
检查两个项目是否是同一类型
Array
uniq(array)
接收一个数组,并返回只包含唯一项目的数组。
merge(...arrays)
合并数组,如果两个项目有相同的id,它们的数量将被合并。
contains(array, condition)
检查数组是否包含具有指定条件的项目。
findOne(array, condition)
查找符合指定条件的对象。
flatten(arrays)
展平阵列。 它很浅。
getIndexByProp(arrays, props = {})
查找符合指定条件的索引。
isEqual(array, otherArray)
检查两个数组是否相同。 它使用深度比较。
grouping(items, key = 'id')
返回符合指定条件的组。
Cookie
parseCookie(cookieString)
从标头“set-cookie”解析 cookie,它返回一个对象。
Object
getKeys(object)
从对象返回所有可迭代的键
isObject(object)
检查项目是否是对象,特别是 typeof null 是对象。
contains(object, otherObject)
检查对象是否包含指定的对象键并且它们的值也相等。
hasKey(object, key)
返回对象的所有可迭代键。
isItem(object)
检查对象是否为 productItem(具有“id”和“quantity”属性)
isEqualItem(item, otherItem)
检查两个项目是否具有相同的 id
isSame(object, otherObject)
检查两个项目是否具有相同的形状。
isEqual(object, otherObject)
检查两个对象是否相等,它使用深度比较。
toCamelCase(object)
将所有键转换为 camelCase 递归地
toJSON(object, camelCase = true)
将对象转换为 json。 默认为 camelCase
String
isString(string)
检查给定项目是否为字符串。
camelCase()
返回将字符串转换为驼峰命名法的函数。
toParamCase(string)
将字符串返回给参数 case
Url
getFriendlyUrl(urlString)
返回一个友好的 url,将所有空格替换为破折号。
getQueryObject(search)
从 url 解析查询字符串。
mergeQueryString(urlstring, queryObject)
将 queryObject 合并到 url。 如果某些查询已经存在,新的查询将附加到 url。
parseUrl(urlString)
从 url 字符串解析 url 对象。 查询也将被解析为一个对象。
kl-utils
A light weight javascript utilities to operate object, arrays and another data types.
Usage
import {objectUtils} from '@kl/utils';
objectUtils.isObject({a: 1});
Types
default
isSameType(item, otherItem)
check if two item is same type
Array
uniq(array)
receive an array, and return array that just contains uniq item.
merge(...arrays)
merge arrays, if two item has same id, them quantity will be merged.
contains(array, condition)
check if an array contains a item that has specified condition.
findOne(array, condition)
find object that match specified condition.
flatten(arrays)
flatten array. it a shallow flatten.
getIndexByProp(arrays, props = {})
find index that matched specified condition.
isEqual(array, otherArray)
check it two arrays is same. it uses deep compare.
grouping(items, key = 'id')
return a group that match specified condition.
Cookie
parseCookie(cookieString)
parse cookie that from headers 'set-cookie', it returns an object.
Object
getKeys(object)
return all iterable keys from object
isObject(object)
check if item is object, especially typeof null is object.
contains(object, otherObject)
check if object contains specified object keys and them value are equals too.
hasKey(object, key)
return all iterable keys of object.
isItem(object)
check if object is productItem(has "id" and "quantity" attributes)
isEqualItem(item, otherItem)
check if two items has same id
isSame(object, otherObject)
check if two items has same shape.
isEqual(object, otherObject)
check if two object is equal, it uses deep compare.
toCamelCase(object)
convert all keys to camelCase recursively
toJSON(object, camelCase = true)
convert object to json. default to camelCase
String
isString(string)
check if given item is string.
camelCase()
return a function that convert string to camelCase.
toParamCase(string)
return a string to param case
Url
getFriendlyUrl(urlString)
return a friendly url that replace all space to dash.
getQueryObject(search)
parse query string from url.
mergeQueryString(urlstring, queryObject)
merge a queryObject to url. if some query already exists, new query will be appended to url.
parseUrl(urlString)
parse url object from url string. query will be parsed to an object too.