npm - gzjs-utils - Versions diffs - 1.0.2 - Mend

gzjs-utils 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (11) hide show

package/LICENSE +21 -0
package/lib/index.js +1 -0
package/package.json +22 -0
package/types/index.d.ts +15 -0
package/types/utils/Base64.d.ts +34 -0
package/types/utils/Bytes.d.ts +65 -0
package/types/utils/Env.d.ts +33 -0
package/types/utils/MD5.d.ts +15 -0
package/types/utils/RTCHttpClient.d.ts +86 -0
package/types/utils/Utils.d.ts +258 -0
package/types/utils/WebRTCIP.d.ts +18 -0

package/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2023 惜～缘
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/lib/index.js ADDED Viewed

@@ -0,0 +1 @@

package/package.json ADDED Viewed

@@ -0,0 +1,22 @@
+{
+  "name": "gzjs-utils",
+  "version": "1.0.2",
+  "description": "smart js utils",
+  "main": "lib/index.js",
+  "typings": "types/index.d.ts",
+  "scripts": {
+    "dev": "npx webpack serve",
+    "build": "cross-env NODE_ENV=production webpack",
+    "test": ""
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitee.com/xiyuan-lgz/gzjs-utils.git"
+  },
+  "keywords": [
+    "js-utils",
+    "util"
+  ],
+  "author": "xiyuan-lgz",
+  "license": "ISC"
+}

package/types/index.d.ts ADDED Viewed

@@ -0,0 +1,15 @@
+import { Bytes } from "./utils/Bytes";
+import { Base64 } from "./utils/Base64";
+import { Utils } from "./utils/Utils";
+import { MD5 } from "./utils/MD5";
+import { WebRTCIP } from "./utils/WebRTCIP";
+import { Env } from "./utils/Env";
+export type JsUtils = Utils & WebRTCIP & {
+    Bytes: Bytes;
+    Base64: Base64;
+    Utils: Utils;
+    MD5: MD5;
+    getEnvironments(): Env;
+};
+declare const _default: JsUtils;
+export default _default;

package/types/utils/Base64.d.ts ADDED Viewed

@@ -0,0 +1,34 @@
+export interface Base64 {
+    /**
+     * 判断是否为base64 内容
+     * @param str
+     */
+    is(str: string): boolean;
+    /**
+     * base64 加密
+     * @param input 需要解密的内容
+     */
+    encode(input: any): string | null | undefined;
+    /**
+     * base64 解密
+     * @param input 待解密内容
+     */
+    decode(input: any): string | null | undefined;
+}
+/**
+ * 判断是否为base64 内容
+ * @param str
+ */
+export declare function is(str: any): boolean;
+/**
+ * base64 加密
+ * @param input 需要解密的内容
+ */
+export declare function encode(input: any): string;
+/**
+ * base64 解密
+ * @param input 待解密内容
+ */
+export declare function decode(input: any): any;
+declare const _Base64_: Base64;
+export default _Base64_;

package/types/utils/Bytes.d.ts ADDED Viewed

@@ -0,0 +1,65 @@
+export declare type Bytes = {
+    /**
+     * 将 数字 转换成 byte, [-128, 127]
+     * @param num
+     */
+    byte(num: string | number): number;
+    /**
+     * 字符串转字节数组,
+     * @param str 字符串
+     */
+    toBytes(str: string): Int8Array;
+    /**
+     * 字节数组转字符串
+     * @param {Int8Array|Uint8Array|[Number]} bytes 字节数组
+     */
+    fromBytes(bytes: Int8Array | Uint8Array | [Number] | unknown): string;
+    /**
+     * 字符串转 16进制字符串
+     * @param str 字符串
+     */
+    toHex(str: string): string;
+    /**
+     * 将十六进制字符串 转化为 Int8Array
+     * @param hexs
+     */
+    fromHex(hexs: string): Int8Array;
+    /**
+     * 字符串转 hex 字符串
+     * @param str
+     */
+    str2hex(str: string): string;
+    /**
+     * 十六进制字符串转String
+     * @param hex
+     */
+    hex2str(hex: string): string;
+};
+/**
+ * 字符串转字节数组,
+ * @param str 字符串
+ */
+declare function toBytes(str: string): Int8Array;
+/**
+ * 字节数组转字符串
+ * @param {Int8Array|Uint8Array|[Number]} bytes 字节数组
+ */
+declare function fromBytes(bytes: Int8Array | Uint8Array | [Number] | unknown): string;
+/**
+ * 将 数字 转换成 byte, [-128, 127]
+ * @param num
+ */
+declare function byte(num: string | number): number;
+/**
+ * 字符串转 16进制字符串
+ * @param str 字符串
+ */
+declare function toHex(str: string): string;
+/**
+ * 将十六进制字符串 转化为 Int8Array
+ * @param hexs
+ */
+declare function fromHex(hexs: string): Int8Array;
+declare const _Bytes_: Bytes;
+export { toBytes, fromBytes, toHex, fromHex, byte };
+export default _Bytes_;

package/types/utils/Env.d.ts ADDED Viewed

@@ -0,0 +1,33 @@
+export type Env = NodeJS.ProcessEnv;
+export declare const getEnvironments: () => Env;
+export interface EnumItem {
+    /**
+     * 枚举项编码，默认枚举值
+     */
+    value: string | number;
+    /**
+     * 枚举项名称
+     */
+    label: string;
+    /**
+     * 枚举项描述
+     */
+    desc?: string;
+    /**
+     * 比较是否相等,
+     * @param val
+     */
+    eq?: (val: any | string) => boolean;
+    /**
+     * 扩展值
+     */
+    vals?: (string | number)[];
+    /**
+     * 文字颜色值
+     */
+    color?: string;
+    /**
+     * 背景颜色
+     */
+    bgColor?: string;
+}

package/types/utils/MD5.d.ts ADDED Viewed

@@ -0,0 +1,15 @@
+export declare type MD5 = {
+    /**
+     * MD5 加密
+     * @param str
+     */
+    encode(str: string): string | null | undefined;
+    /**
+     * hmac_md5 加密
+     * @param key 加密密钥
+     * @param str 加密内容
+     */
+    hmac_md5(key: string, str: string): string | null | undefined;
+};
+declare const _MD5_: MD5;
+export default _MD5_;

package/types/utils/RTCHttpClient.d.ts ADDED Viewed

@@ -0,0 +1,86 @@
+export declare class RTCHttpHeader {
+    private store;
+    getHeader(name: string): any;
+    addHeader(name: string, value: string | number): void;
+    getHeaderNames(): string[];
+    removeHeader(name: string): void;
+    values(): string[];
+    has(name: string): boolean;
+    entries(): [string, any][];
+}
+export declare class HttpResult {
+    private headers;
+    private responseData;
+    private statusCode;
+    private statusMsg;
+    constructor(props: {
+        headers: Record<string, string>;
+        statusCode: number;
+        statusMsg: string;
+        responseData: Int8Array | null;
+        config: any;
+    });
+    /**
+     * 获取HTTP响应头
+     */
+    getHeaders(): Record<any, string>;
+    /**
+     * 指定获取响应头
+     * @param name
+     */
+    getHeader(name: string): string;
+    /**
+     * 获取响应状态码
+     */
+    getStatusCode(): number;
+    /**
+     * 获取状态码消息
+     */
+    getStatusMsg(): string;
+    /**
+     * 获取获取响应文本
+     */
+    getResponseText(): string | null;
+    /**
+     * 获取响应数据流
+     */
+    getResponseData(): Int8Array | null;
+}
+export type HttpRequestConfig = {};
+export declare class RTCHttpClient {
+    private readonly id;
+    constructor(props: HttpRequestConfig);
+    getId(): string;
+    /**
+     * post 请求
+     * @param url
+     * @param data 请求数据
+     * @param params url 参数
+     * @param headers 自定义请求头
+     */
+    post(url: string, data?: any, params?: Record<any, any>, headers?: Record<any, string>): Promise<HttpResult>;
+    /**
+     * get 请求
+     * @param url
+     * @param params
+     * @param headers
+     */
+    get(url: string, params?: Record<any, any>, headers?: Record<any, string>): Promise<HttpResult>;
+    request(params: {
+        url: string;
+        method?: string | "GET";
+        params?: Record<string, any>;
+        data?: any;
+        headers?: Record<string, string>;
+    }): Promise<HttpResult>;
+}
+export declare const instance: (config: HttpRequestConfig) => RTCHttpClient;
+export declare function request(params: {
+    url: string;
+    method?: string | "GET";
+    params?: Record<string, any>;
+    data?: any;
+    headers?: Record<string, string>;
+}, config?: HttpRequestConfig): Promise<HttpResult>;
+declare const defaults: RTCHttpClient;
+export default defaults;

package/types/utils/Utils.d.ts ADDED Viewed

@@ -0,0 +1,258 @@
+declare type any_str = string | undefined | null;
+/**
+ * 年份
+ */
+declare type year = number;
+/**
+ * 月数
+ */
+declare type moth = number;
+/**
+ * 天数
+ */
+declare type day = number;
+/**
+ * 0=trim左右空白
+ * 1=trim左边空白
+ * 2=trim右边空白
+ */
+declare type TrimMode = 0 | 1 | 2;
+export type TreeNodeEF = {
+    __level__: number;
+    __isRoot__: boolean;
+};
+/**
+ * @param curr 当前项
+ * @param parent 父项
+ * @param idx 当前项目所在列表中的索引
+ * @param arr 当前项所在的列表对象
+ */
+export type EachTreeProcesstor<T> = {
+    (curr: T, parent: T | null, idx: number, arr: T[]): any;
+};
+export type URI = {
+    "source": string | "";
+    "protocol": string | "";
+    "authority": string | "";
+    "userInfo": string | "";
+    "user": string | "";
+    "password": string | "";
+    "host": string | "";
+    "port": string | "";
+    "relative": string | "";
+    "path": string | "";
+    "directory": string | "";
+    "file": string | "";
+    "query": string | "";
+    anchor: string | "";
+    "origin": string | "";
+    params: {
+        [key: string]: string | boolean | any[] | "";
+    };
+};
+export declare type Utils = {
+    /**
+     * 获取对象类型；
+     * <p>
+     * 例如：
+     * <pre>
+     *     // type('123') 则返回 String
+     *     // type(133) 则返回 Number
+     *     // type([]) 则返回 Array
+     *     // type() 则返回 Undefined
+     *     // type(null) 则返回 null
+     * </pre>
+     *
+     * @param obj
+     */
+    type(obj: any): string;
+    /**
+     * 是否为 String 类型
+     * @param obj
+     */
+    isString(obj: any): boolean;
+    /**
+     * 判断对象是否为 函数类型
+     * @param obj
+     */
+    isFunction(obj: any): boolean;
+    /**
+     * 获取字符串中包含的中文个数
+     * @param obj
+     */
+    chineseLen(obj: any_str): number;
+    /**
+     * 将字符串去空白
+     * @param str
+     * @param flag
+     */
+    trim(str: any_str, flag?: TrimMode): string | any;
+    /**
+     * 最忌打乱数组顺序
+     * @param arr
+     */
+    shuffle<T>(arr: T[] | any): T[] | any;
+    /**
+     * 生成UUID
+     */
+    uuid(): string;
+    /**
+     * 获取随机数, 默认 字母+数组
+     * @param len 随机数长度
+     * @param typeOrSource 随机数类型：1=字母+数字， 2=数字 ， 3=字母,或者数据元
+     */
+    random(len?: number, typeOrSource?: 1 | 2 | 3 | (number | string)[] | string): string;
+    /**
+     * 数据进行分页
+     * <pre>
+     *    // pageNo,从1开始， 如果指定 分页页码返回指定页码 的数据，默认返回全部数据
+     *    page([1,2,3,4,5,6,7,8,9,10], 3) // 返回 [[1,2,3],[4,5,6],[7,8,9],[10]]
+     *    page([1,2,3,4,5,6,7,8,9,10], 3, 3) // 返回 [[7,8,9]]
+     * </pre>
+     * @param arr 数据列表
+     * @param pageSize 分页大小
+     * @param pageNo 获取第几页的数据,从1开始，默认返回全部数据，如果指定 分页页码返回指定页码 的数据，
+     */
+    page<T = any>(arr: T[], pageSize: number, pageNo?: number): T[][];
+    /**
+     * 获取 URL 路径中的参数
+     * @param url
+     * @param key
+     */
+    getUrlParam(url: string, key: string): string | null | any;
+    /**
+     * 获取 URL 路径中的所有参数
+     * @param url
+     */
+    getUrlParams(url: string): Record<string, string | null> | object;
+    /**
+     * 获取 URL 路径中的 search 值
+     * @param url
+     */
+    /**
+     * 给定uri 解析
+     * @param source
+     */
+    parseUri(source: string | ""): URI;
+    /**
+     * 解析url查询参数 并封装为 参数 对象
+     * @param search
+     */
+    parseQuery(search: string | ""): {
+        [key: string]: string | boolean | any[] | "";
+    };
+    /**
+     * 获取查询参数
+     * @param search 查询参数，如果为空则会 从url 读取
+     * @param allowFromLocation 允许从 location 上获取
+     */
+    getQueryParams(search?: string, allowFromLocation?: boolean): Record<any, string | number | boolean | null> | object;
+    /**
+     * 字符串是否全部是中文
+     * @param obj
+     */
+    isChinese(obj: any_str): boolean;
+    /**
+     * 是否为数组类型
+     * @param obj
+     */
+    isArray(obj: any): boolean;
+    /**
+     * 判断是否为空 支持对象 字符串，map set array 等
+     * @param str
+     */
+    isEmpty(str: any): boolean;
+    /**
+     * 判断是否为空
+     * @param str
+     */
+    isBlank(str: any): boolean;
+    /**
+     * 是否为手机号
+     * @param str
+     */
+    isMobile(str: any_str): boolean;
+    /**
+     * 判断是否是安卓设备
+     */
+    isAndroid(): boolean;
+    /**
+     * 是否为闰年
+     * @param str yyyy格式
+     */
+    isLeapYear(str: number | string): boolean;
+    /**
+     * 校验非法字符
+     * @param str
+     */
+    isScript(str: string): boolean;
+    /**
+     * 判断是否为 身份证
+     * @param obj
+     */
+    isIDCard(obj: string): boolean;
+    /**
+     * 从身份证获取年龄
+     * @param obj
+     */
+    getAgeFromIDcard(obj: string): [year, moth, day] | [];
+    /**
+     * 判断是否为URL 这里只判断 str 必须有协议部分，比如：http://baidu.com 则返回true, //baidu.com 或者 baidu.com 返回false
+     * @param str
+     */
+    isUrl(str: any_str): boolean;
+    /**
+     * 判断 是否为http
+     * @param str
+     */
+    isHttp(str: any_str): boolean;
+    /**
+     * 判断是否为 https
+     * @param str
+     */
+    isHttps(str: any_str): boolean;
+    /**
+     * 是否为IP V6
+     * @param str
+     */
+    isIPv6(str: any_str): boolean;
+    isIPv4(str: any_str): boolean;
+    /**
+     * 获取当前IP
+     * @param str
+     * @param v6
+     */
+    isIP(str: any_str, v6?: boolean): boolean;
+    /**
+     * 构建树型结构
+     * @param arr   数据列表
+     * @param idField id 唯一标识节点名称
+     * @param parentField 父级节点名称
+     * @param childrenField 子节点名称
+     */
+    buildTree<T, R = T & TreeNodeEF>(arr: T[], idField?: "id", parentField?: "parentId", childrenField?: "children"): R[];
+    /**
+     * 遍历树节点
+     * @param arr
+     * @param processter
+     * @param childrenKey
+     */
+    eachTree<T, R = T>(arr: T[], processter: EachTreeProcesstor<T>, childrenKey?: string | 'children'): R[];
+    /**
+     * 输转 数组
+     * @param arr
+     * @param childrenKey
+     * @param removeChildren 是否删除 children 节点
+     */
+    treeToArray<T>(arr: T[] | T, childrenKey?: string, removeChildren?: boolean): T[];
+    /**
+     * 查找 树节点 只返回一项
+     * @param treeList
+     * @param filter
+     * @param childrenKey
+     */
+    findTreeItem<T>(treeList: T[], filter: (c: T, p: T | null) => boolean, childrenKey?: string | ((c: T) => T[])): T | null;
+};
+export declare function uuid(len: number): string;
+declare const _Utils_: Utils;
+export default _Utils_;

package/types/utils/WebRTCIP.d.ts ADDED Viewed

@@ -0,0 +1,18 @@
+declare type IpRet = {
+    public: IpItem[];
+    private: IpItem[];
+};
+declare type IpItem = {
+    ip: string;
+    IPv4: boolean;
+    type: "public" | "private" | "IPv6";
+};
+export declare type WebRTCIP = {
+    /**
+     * 获取IP信息W
+     * @param timeout 超时时间
+     */
+    getIPs(timeout?: number): Promise<IpRet>;
+};
+declare const _WebRTCIP_: WebRTCIP;
+export default _WebRTCIP_;