@cclr/lang 0.0.3 → 0.0.6

package/lib/cjs/index.js

@@ -0,0 +1,143 @@
+'use strict';
+
+const VAL_TYPE = {
+    boolean: "boolean",
+    undefined: "undefined",
+    number: "undefined",
+    string: "string",
+    null: "null",
+    "[object Object]": "object",
+    "[object Function]": "function",
+    "[object RegExp]": "regexp",
+    "[object Array]": "array",
+    "[object Date]": "date",
+    "[object Error]": "error",
+    "[object Blob]": "blob",
+    "[object File]": "file",
+    "[object ArrayBuffer]": "arrayBuffer",
+};
+
+/**
+ * 获取参数类型
+ * @param p 参数
+ * @returns
+ */
+function getParamType(p) {
+    return (VAL_TYPE[typeof p] ||
+        VAL_TYPE[Object.prototype.toString.call(p)] ||
+        (p ? "object" : "null"));
+}
+function isType(params, type) {
+    return getParamType(params) === type;
+}
+function isString(s) {
+    return getParamType(s) === "string";
+}
+function isBoolean(b) {
+    return getParamType(b) === "boolean";
+}
+function isFunction(b) {
+    return getParamType(b) === "function";
+}
+function isPlainObject(b) {
+    return Object.prototype.toString.call(b) === "[object Object]";
+}
+function isObject(b) {
+    return getParamType(b) === "object";
+}
+function isArray(a) {
+    return Array.isArray(a);
+}
+function isNull(v) {
+    return v === null;
+}
+function isUndefined(v) {
+    return v === undefined;
+}
+function isUndefinedOrNull(v) {
+    return isNull(v) || isUndefined(v);
+}
+
+const enumToArray = (e) => {
+    if (isPlainObject(e)) {
+        return [Object.keys(e)];
+    }
+    return [];
+};
+
+/* eslint-disable @typescript-eslint/no-unsafe-return */
+const loopObjectRead = (source, [head, ...tail]) => {
+    source = source[head];
+    return tail.length && source ? loopObjectRead(source, tail) : source;
+};
+/**
+ * Gets the value at path of object. TODO: typings.
+ * @param source The object to query.
+ * @param path The path of the property to get.
+ * @param [defaultValue] The value returned for undefined resolved values.
+ */
+const get = (source, path, defaultValue) => {
+    const result = loopObjectRead(source || {}, path.split("."));
+    return isUndefined(result) || isNull(result) ? defaultValue : result;
+};
+
+const loopObjectSet = (source, [head, ...tail], value) => {
+    source = source[head] = tail.length ? source[head] || {} : value;
+    if (tail.length) {
+        if (isPlainObject(source) && !isArray(source)) {
+            loopObjectSet(source, tail, value);
+        }
+        else {
+            throw new Error(`path node ['.${head}'] must be plain object {}!`);
+        }
+    }
+};
+/**
+ * Sets the value at path of object. If a portion of path doesn't exist, it's created.
+ * @param source The object to modify.
+ * @param path The path of the property to set.
+ * @param value The value to set.
+ */
+const set = (source, path, value) => {
+    source = source || {};
+    loopObjectSet(source, path.split("."), value);
+    return source;
+};
+
+/**
+ * A function that returns a universally unique identifier (uuid).
+ * Note: If used in long period data storage it is best to add a time stamp (e.g. logging)
+ * @example
+ * 1b83fd69-abe7-468c-bea1-306a8aa1c81d
+ * @returns `string` : 32 character uuid (see example)
+ */
+const uuid = () => {
+    const hashTable = ['a', 'b', 'c', 'd', 'e', 'f', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9'];
+    const uuid = [];
+    for (let i = 0; i < 36; i++) {
+        if (i === 8 || i === 13 || i === 18 || i === 23) {
+            uuid[i] = '-';
+        }
+        else {
+            uuid[i] = hashTable[Math.ceil(Math.random() * hashTable.length - 1)];
+        }
+    }
+    return uuid.join('');
+};
+
+exports.VAL_TYPE = VAL_TYPE;
+exports.enumToArray = enumToArray;
+exports.get = get;
+exports.getParamType = getParamType;
+exports.isArray = isArray;
+exports.isBoolean = isBoolean;
+exports.isFunction = isFunction;
+exports.isNull = isNull;
+exports.isObject = isObject;
+exports.isPlainObject = isPlainObject;
+exports.isString = isString;
+exports.isType = isType;
+exports.isUndefined = isUndefined;
+exports.isUndefinedOrNull = isUndefinedOrNull;
+exports.set = set;
+exports.uuid = uuid;

package/lib/esm/index.js

@@ -0,0 +1,126 @@
+const VAL_TYPE = {
+    boolean: "boolean",
+    undefined: "undefined",
+    number: "undefined",
+    string: "string",
+    null: "null",
+    "[object Object]": "object",
+    "[object Function]": "function",
+    "[object RegExp]": "regexp",
+    "[object Array]": "array",
+    "[object Date]": "date",
+    "[object Error]": "error",
+    "[object Blob]": "blob",
+    "[object File]": "file",
+    "[object ArrayBuffer]": "arrayBuffer",
+};
+
+/**
+ * 获取参数类型
+ * @param p 参数
+ * @returns
+ */
+function getParamType(p) {
+    return (VAL_TYPE[typeof p] ||
+        VAL_TYPE[Object.prototype.toString.call(p)] ||
+        (p ? "object" : "null"));
+}
+function isType(params, type) {
+    return getParamType(params) === type;
+}
+function isString(s) {
+    return getParamType(s) === "string";
+}
+function isBoolean(b) {
+    return getParamType(b) === "boolean";
+}
+function isFunction(b) {
+    return getParamType(b) === "function";
+}
+function isPlainObject(b) {
+    return Object.prototype.toString.call(b) === "[object Object]";
+}
+function isObject(b) {
+    return getParamType(b) === "object";
+}
+function isArray(a) {
+    return Array.isArray(a);
+}
+function isNull(v) {
+    return v === null;
+}
+function isUndefined(v) {
+    return v === undefined;
+}
+function isUndefinedOrNull(v) {
+    return isNull(v) || isUndefined(v);
+}
+
+const enumToArray = (e) => {
+    if (isPlainObject(e)) {
+        return [Object.keys(e)];
+    }
+    return [];
+};
+
+/* eslint-disable @typescript-eslint/no-unsafe-return */
+const loopObjectRead = (source, [head, ...tail]) => {
+    source = source[head];
+    return tail.length && source ? loopObjectRead(source, tail) : source;
+};
+/**
+ * Gets the value at path of object. TODO: typings.
+ * @param source The object to query.
+ * @param path The path of the property to get.
+ * @param [defaultValue] The value returned for undefined resolved values.
+ */
+const get = (source, path, defaultValue) => {
+    const result = loopObjectRead(source || {}, path.split("."));
+    return isUndefined(result) || isNull(result) ? defaultValue : result;
+};
+
+const loopObjectSet = (source, [head, ...tail], value) => {
+    source = source[head] = tail.length ? source[head] || {} : value;
+    if (tail.length) {
+        if (isPlainObject(source) && !isArray(source)) {
+            loopObjectSet(source, tail, value);
+        }
+        else {
+            throw new Error(`path node ['.${head}'] must be plain object {}!`);
+        }
+    }
+};
+/**
+ * Sets the value at path of object. If a portion of path doesn't exist, it's created.
+ * @param source The object to modify.
+ * @param path The path of the property to set.
+ * @param value The value to set.
+ */
+const set = (source, path, value) => {
+    source = source || {};
+    loopObjectSet(source, path.split("."), value);
+    return source;
+};
+
+/**
+ * A function that returns a universally unique identifier (uuid).
+ * Note: If used in long period data storage it is best to add a time stamp (e.g. logging)
+ * @example
+ * 1b83fd69-abe7-468c-bea1-306a8aa1c81d
+ * @returns `string` : 32 character uuid (see example)
+ */
+const uuid = () => {
+    const hashTable = ['a', 'b', 'c', 'd', 'e', 'f', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9'];
+    const uuid = [];
+    for (let i = 0; i < 36; i++) {
+        if (i === 8 || i === 13 || i === 18 || i === 23) {
+            uuid[i] = '-';
+        }
+        else {
+            uuid[i] = hashTable[Math.ceil(Math.random() * hashTable.length - 1)];
+        }
+    }
+    return uuid.join('');
+};
+
+export { VAL_TYPE, enumToArray, get, getParamType, isArray, isBoolean, isFunction, isNull, isObject, isPlainObject, isString, isType, isUndefined, isUndefinedOrNull, set, uuid };

package/lib/type/index.d.ts

@@ -0,0 +1,66 @@
+declare const VAL_TYPE: {
+    readonly boolean: "boolean";
+    readonly undefined: "undefined";
+    readonly number: "undefined";
+    readonly string: "string";
+    readonly null: "null";
+    readonly "[object Object]": "object";
+    readonly "[object Function]": "function";
+    readonly "[object RegExp]": "regexp";
+    readonly "[object Array]": "array";
+    readonly "[object Date]": "date";
+    readonly "[object Error]": "error";
+    readonly "[object Blob]": "blob";
+    readonly "[object File]": "file";
+    readonly "[object ArrayBuffer]": "arrayBuffer";
+};
+type TVal = (typeof VAL_TYPE)[keyof typeof VAL_TYPE];
+
+/**
+ * 获取参数类型
+ * @param p 参数
+ * @returns
+ */
+declare function getParamType(p: unknown): TVal;
+declare function isType(params: any, type: TVal): boolean;
+declare function isString(s: any): s is String;
+declare function isBoolean(b: any): b is Boolean;
+declare function isFunction(b: any): b is Function;
+declare function isPlainObject(b: any): b is Record<string, unknown>;
+declare function isObject(b: any): b is Record<string, unknown>;
+declare function isArray(a: any): a is any[];
+declare function isNull(v: any): v is null;
+declare function isUndefined(v: any): v is undefined;
+declare function isUndefinedOrNull(v: any): v is undefined | null;
+
+type TAny = any;
+type TPlainObject = Record<string, TAny>;
+
+declare const enumToArray: (e: TPlainObject) => string[][];
+
+/**
+ * Gets the value at path of object. TODO: typings.
+ * @param source The object to query.
+ * @param path The path of the property to get.
+ * @param [defaultValue] The value returned for undefined resolved values.
+ */
+declare const get: <T>(source: T, path: string, defaultValue?: any) => any;
+
+/**
+ * Sets the value at path of object. If a portion of path doesn't exist, it's created.
+ * @param source The object to modify.
+ * @param path The path of the property to set.
+ * @param value The value to set.
+ */
+declare const set: (source: object | null | undefined, path: string, value: any) => object;
+
+/**
+ * A function that returns a universally unique identifier (uuid).
+ * Note: If used in long period data storage it is best to add a time stamp (e.g. logging)
+ * @example
+ * 1b83fd69-abe7-468c-bea1-306a8aa1c81d
+ * @returns `string` : 32 character uuid (see example)
+ */
+declare const uuid: () => string;
+
+export { type TAny, type TPlainObject, type TVal, VAL_TYPE, enumToArray, get, getParamType, isArray, isBoolean, isFunction, isNull, isObject, isPlainObject, isString, isType, isUndefined, isUndefinedOrNull, set, uuid };

package/package.json

@@ -1,21 +1,19 @@
 {
   "name": "@cclr/lang",
-  "version": "0.0.3",
-  "description": "> TODO: description",
+  "version": "0.0.6",
+  "description": "js语言基础工具",
   "author": "cclr <18843152354@163.com>",
   "homepage": "",
   "license": "ISC",
-  "main": "cjs/lang.js",
-  "module": "esm/index.js",
-  "types": "./index.d.ts",
+  "main": "lib/cjs/index.js",
+  "module": "lib/esm/index.js",
+  "types": "lib/type/index.d.ts",
   "directories": {
     "lib": "lib",
     "test": "__tests__"
   },
   "files": [
-    "cjs",
-    "esm",
-    "index.d.ts",
+    "lib",
     "README.md"
   ],
   "publishConfig": {
@@ -25,5 +23,5 @@
   "scripts": {
     "test": "node ./__tests__/lang.test.js"
   },
-  "gitHead": "3b2ad8f10a1334a9876d31e0bf4a16074da88269"
+  "gitHead": "e2a9c7f3d406d70510ed008f38fed383f4fa31c1"
 }

package/cjs/index.js

@@ -1,56 +0,0 @@
-'use strict';
-
-const VAL_TYPE = {
-    boolean: "boolean",
-    undefined: "undefined",
-    number: "undefined",
-    string: "string",
-    null: "null",
-    "[object Object]": "object",
-    "[object Function]": "function",
-    "[object RegExp]": "regexp",
-    "[object Array]": "array",
-    "[object Date]": "date",
-    "[object Error]": "error",
-    "[object Blob]": "blob",
-    "[object File]": "file",
-    "[object ArrayBuffer]": "arrayBuffer",
-};
-
-/**
- * 获取参数类型
- * @param p 参数
- * @returns
- */
-function getParamType(p) {
-    return (VAL_TYPE[typeof p] ||
-        VAL_TYPE[Object.prototype.toString.call(p)] ||
-        (p ? "object" : "null"));
-}
-function isType(params, type) {
-    return getParamType(params) === type;
-}
-function isString(s) {
-    return getParamType(s) === "string";
-}
-function isBoolean(b) {
-    return getParamType(b) === "boolean";
-}
-function isFunction(b) {
-    return getParamType(b) === "function";
-}
-function isPlainObject(b) {
-    return getParamType(b) === "object";
-}
-function isArray(a) {
-    return Array.isArray(a);
-}
-
-exports.VAL_TYPE = VAL_TYPE;
-exports.getParamType = getParamType;
-exports.isArray = isArray;
-exports.isBoolean = isBoolean;
-exports.isFunction = isFunction;
-exports.isPlainObject = isPlainObject;
-exports.isString = isString;
-exports.isType = isType;

package/cjs/src/common-type.d.ts

@@ -1,2 +0,0 @@
-export type TAny = any;
-export type TPlainObject = Record<string, TAny>;

package/cjs/src/index.d.ts

@@ -1,3 +0,0 @@
-export * from './type-asserts';
-export * from './common-type';
-export * from './value-type';

package/cjs/src/type-asserts.d.ts

@@ -1,14 +0,0 @@
-import { TVal } from "./value-type";
-/**
- * 获取参数类型
- * @param p 参数
- * @returns
- */
-declare function getParamType(p: unknown): TVal;
-declare function isType(params: any, type: TVal): boolean;
-declare function isString(s: any): s is String;
-declare function isBoolean(b: any): b is Boolean;
-declare function isFunction(b: any): b is Function;
-declare function isPlainObject(b: any): b is Record<string, unknown>;
-declare function isArray(a: any): a is any[];
-export { getParamType, isType, isString, isBoolean, isFunction, isArray, isPlainObject, };

package/cjs/src/value-type.d.ts

@@ -1,17 +0,0 @@
-export declare const VAL_TYPE: {
-    readonly boolean: "boolean";
-    readonly undefined: "undefined";
-    readonly number: "undefined";
-    readonly string: "string";
-    readonly null: "null";
-    readonly "[object Object]": "object";
-    readonly "[object Function]": "function";
-    readonly "[object RegExp]": "regexp";
-    readonly "[object Array]": "array";
-    readonly "[object Date]": "date";
-    readonly "[object Error]": "error";
-    readonly "[object Blob]": "blob";
-    readonly "[object File]": "file";
-    readonly "[object ArrayBuffer]": "arrayBuffer";
-};
-export type TVal = typeof VAL_TYPE[keyof typeof VAL_TYPE];

package/esm/index.js

@@ -1,47 +0,0 @@
-const VAL_TYPE = {
-    boolean: "boolean",
-    undefined: "undefined",
-    number: "undefined",
-    string: "string",
-    null: "null",
-    "[object Object]": "object",
-    "[object Function]": "function",
-    "[object RegExp]": "regexp",
-    "[object Array]": "array",
-    "[object Date]": "date",
-    "[object Error]": "error",
-    "[object Blob]": "blob",
-    "[object File]": "file",
-    "[object ArrayBuffer]": "arrayBuffer",
-};
-
-/**
- * 获取参数类型
- * @param p 参数
- * @returns
- */
-function getParamType(p) {
-    return (VAL_TYPE[typeof p] ||
-        VAL_TYPE[Object.prototype.toString.call(p)] ||
-        (p ? "object" : "null"));
-}
-function isType(params, type) {
-    return getParamType(params) === type;
-}
-function isString(s) {
-    return getParamType(s) === "string";
-}
-function isBoolean(b) {
-    return getParamType(b) === "boolean";
-}
-function isFunction(b) {
-    return getParamType(b) === "function";
-}
-function isPlainObject(b) {
-    return getParamType(b) === "object";
-}
-function isArray(a) {
-    return Array.isArray(a);
-}
-
-export { VAL_TYPE, getParamType, isArray, isBoolean, isFunction, isPlainObject, isString, isType };

package/esm/src/common-type.d.ts

@@ -1,2 +0,0 @@
-export type TAny = any;
-export type TPlainObject = Record<string, TAny>;

package/esm/src/index.d.ts

@@ -1,3 +0,0 @@
-export * from './type-asserts';
-export * from './common-type';
-export * from './value-type';

package/esm/src/type-asserts.d.ts

@@ -1,14 +0,0 @@
-import { TVal } from "./value-type";
-/**
- * 获取参数类型
- * @param p 参数
- * @returns
- */
-declare function getParamType(p: unknown): TVal;
-declare function isType(params: any, type: TVal): boolean;
-declare function isString(s: any): s is String;
-declare function isBoolean(b: any): b is Boolean;
-declare function isFunction(b: any): b is Function;
-declare function isPlainObject(b: any): b is Record<string, unknown>;
-declare function isArray(a: any): a is any[];
-export { getParamType, isType, isString, isBoolean, isFunction, isArray, isPlainObject, };

package/esm/src/value-type.d.ts

@@ -1,17 +0,0 @@
-export declare const VAL_TYPE: {
-    readonly boolean: "boolean";
-    readonly undefined: "undefined";
-    readonly number: "undefined";
-    readonly string: "string";
-    readonly null: "null";
-    readonly "[object Object]": "object";
-    readonly "[object Function]": "function";
-    readonly "[object RegExp]": "regexp";
-    readonly "[object Array]": "array";
-    readonly "[object Date]": "date";
-    readonly "[object Error]": "error";
-    readonly "[object Blob]": "blob";
-    readonly "[object File]": "file";
-    readonly "[object ArrayBuffer]": "arrayBuffer";
-};
-export type TVal = typeof VAL_TYPE[keyof typeof VAL_TYPE];

package/index.d.ts

@@ -1 +0,0 @@
-export * from './esm/src';