extra-utils 5.3.0 → 5.5.0

package/lib/string/remove-blank-lines.js

@@ -1,8 +1,8 @@
-import { isntBlankLine } from './utils.js';
-export function removeBlankLines(text) {
-    return text
-        .split('\n')
-        .filter(line => isntBlankLine(line))
-        .join('\n');
-}
+import { isntBlankLine } from './utils.js';
+export function removeBlankLines(text) {
+    return text
+        .split('\n')
+        .filter(line => isntBlankLine(line))
+        .join('\n');
+}
 //# sourceMappingURL=remove-blank-lines.js.map

package/lib/string/remove-extra-indents.d.ts

@@ -1,3 +1,3 @@
-export declare function removeExtraIndents(text: string, { ignoreBlankLines }?: {
-    ignoreBlankLines?: boolean;
-}): string;
+export declare function removeExtraIndents(text: string, { ignoreBlankLines }?: {
+    ignoreBlankLines?: boolean;
+}): string;

package/lib/string/remove-extra-indents.js

@@ -1,21 +1,21 @@
-import { isntBlankLine } from './utils.js';
-export function removeExtraIndents(text, { ignoreBlankLines = false } = {}) {
-    const lines = text.split('\n');
-    const commonIndentLength = lines
-        .filter(line => ignoreBlankLines ? isntBlankLine(line) : true)
-        .reduce((acc, cur) => {
-        const indent = cur.match(/^(\s+)/);
-        if (indent) {
-            return Math.min(acc, indent[1].length);
-        }
-        else {
-            return 0;
-        }
-    }, Infinity);
-    if (commonIndentLength === 0 || commonIndentLength === Infinity) {
-        return text;
-    }
-    const newLines = lines.map(x => x.slice(commonIndentLength));
-    return newLines.join('\n');
-}
+import { isntBlankLine } from './utils.js';
+export function removeExtraIndents(text, { ignoreBlankLines = false } = {}) {
+    const lines = text.split('\n');
+    const commonIndentLength = lines
+        .filter(line => ignoreBlankLines ? isntBlankLine(line) : true)
+        .reduce((acc, cur) => {
+        const indent = cur.match(/^(\s+)/);
+        if (indent) {
+            return Math.min(acc, indent[1].length);
+        }
+        else {
+            return 0;
+        }
+    }, Infinity);
+    if (commonIndentLength === 0 || commonIndentLength === Infinity) {
+        return text;
+    }
+    const newLines = lines.map(x => x.slice(commonIndentLength));
+    return newLines.join('\n');
+}
 //# sourceMappingURL=remove-extra-indents.js.map

package/lib/string/remove-leading-blank-lines.d.ts

@@ -1 +1 @@
-export declare function removeLeadingBlankLines(text: string, maxRemovals?: number): string;
+export declare function removeLeadingBlankLines(text: string, maxRemovals?: number): string;

package/lib/string/remove-leading-blank-lines.js

@@ -1,13 +1,13 @@
-import { isBlankLine } from './utils.js';
-export function removeLeadingBlankLines(text, maxRemovals = Infinity) {
-    const lines = text.split('\n');
-    let removals = 0;
-    while (removals < maxRemovals &&
-        lines.length > 0 &&
-        isBlankLine(lines[0])) {
-        lines.shift();
-        removals++;
-    }
-    return lines.join('\n');
-}
+import { isBlankLine } from './utils.js';
+export function removeLeadingBlankLines(text, maxRemovals = Infinity) {
+    const lines = text.split('\n');
+    let removals = 0;
+    while (removals < maxRemovals &&
+        lines.length > 0 &&
+        isBlankLine(lines[0])) {
+        lines.shift();
+        removals++;
+    }
+    return lines.join('\n');
+}
 //# sourceMappingURL=remove-leading-blank-lines.js.map

package/lib/string/remove-trailing-blank-lines.d.ts

@@ -1 +1 @@
-export declare function removeTrailingBlankLines(text: string, maxRemovals?: number): string;
+export declare function removeTrailingBlankLines(text: string, maxRemovals?: number): string;

package/lib/string/remove-trailing-blank-lines.js

@@ -1,13 +1,13 @@
-import { isBlankLine } from './utils.js';
-export function removeTrailingBlankLines(text, maxRemovals = Infinity) {
-    const lines = text.split('\n');
-    let removals = 0;
-    while (removals < maxRemovals &&
-        lines.length > 0 &&
-        isBlankLine(lines[lines.length - 1])) {
-        lines.pop();
-        removals++;
-    }
-    return lines.join('\n');
-}
+import { isBlankLine } from './utils.js';
+export function removeTrailingBlankLines(text, maxRemovals = Infinity) {
+    const lines = text.split('\n');
+    let removals = 0;
+    while (removals < maxRemovals &&
+        lines.length > 0 &&
+        isBlankLine(lines[lines.length - 1])) {
+        lines.pop();
+        removals++;
+    }
+    return lines.join('\n');
+}
 //# sourceMappingURL=remove-trailing-blank-lines.js.map

package/lib/string/to-string.d.ts

@@ -1 +1 @@
-export declare function toString(val: unknown): string;
+export declare function toString(val: unknown): string;

package/lib/string/to-string.js

@@ -1,4 +1,4 @@
-export function toString(val) {
-    return `${val}`;
-}
+export function toString(val) {
+    return `${val}`;
+}
 //# sourceMappingURL=to-string.js.map

package/lib/string/utils.d.ts

@@ -1,2 +1,2 @@
-export declare function isBlankLine(line: string): boolean;
-export declare function isntBlankLine(line: string): boolean;
+export declare function isBlankLine(line: string): boolean;
+export declare function isntBlankLine(line: string): boolean;

package/lib/string/utils.js

@@ -1,7 +1,7 @@
-export function isBlankLine(line) {
-    return line.trim() === '';
-}
-export function isntBlankLine(line) {
-    return !isBlankLine(line);
-}
+export function isBlankLine(line) {
+    return line.trim() === '';
+}
+export function isntBlankLine(line) {
+    return !isBlankLine(line);
+}
 //# sourceMappingURL=utils.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "extra-utils",
-  "version": "5.3.0",
+  "version": "5.5.0",
   "description": "Utilities for JavaScript and Typescript",
   "files": [
     "src",

package/src/enum/enum-entries.ts

@@ -0,0 +1,7 @@
+import { enumKeys } from './enum-keys.js'
+
+export function enumEntries<T extends Record<string | number, string | number>>(
+  _enum: T
+): Array<{ [Key in keyof T]: [Key, T[Key]] }[keyof T]> {
+  return enumKeys(_enum).map(key => [key, _enum[key]])
+}

package/src/enum/enum-keys.ts

@@ -0,0 +1,6 @@
+export function enumKeys<T extends Record<string | number, string | number>>(
+  _enum: T
+): Array<keyof T> {
+  return Object.keys(_enum)
+    .filter(key => Number.isNaN(Number(key))) // TypeScript枚举不能以数值为键
+}

package/src/enum/enum-values.ts

@@ -0,0 +1,8 @@
+import { enumKeys } from './enum-keys.js'
+
+export function enumValues<T extends Record<string | number, string | number>>(
+  _enum: T
+): Array<T[keyof T]> {
+  const keys = enumKeys(_enum)
+  return keys.map(key => _enum[key])
+}

package/src/enum/in-enum.ts

@@ -0,0 +1,16 @@
+import { enumValues } from './enum-values.js'
+
+export function inEnum<T extends Record<string | number, string | number>>(
+  val: string | number
+, _enum: T
+): val is T[keyof T] {
+  return enumValues(_enum).includes(val as T[keyof T])
+}
+
+// 由于TypeScript无法从string | number里精确排除掉枚举类型, 因此返回值为boolean.
+export function notInEnum(
+  val: string | number
+, _enum: Record<string | number, string | number>
+): boolean {
+  return !inEnum(val, _enum)
+}

package/src/enum/index.ts

@@ -0,0 +1,4 @@
+export * from './in-enum.js'
+export * from './enum-keys.js'
+export * from './enum-values.js'
+export * from './enum-entries.js'

package/src/index.ts

@@ -6,7 +6,7 @@ export * from './object/index.js'
 export * from './json/index.js'
 export * from './string/index.js'
 export * from './nullish/index.js'
-export * from './in-enum.js'
+export * from './enum/index.js'
 export * from './is-regexp.js'
 export * from './is-symbol.js'
 export * from './is-date.js'

package/src/object/index.ts

@@ -1,3 +1,6 @@
 export * from './is-empty-object.js'
 export * from './is-object.js'
 export * from './is-plain-object.js'
+export * from './is-reference-equal.js'
+export * from './is-shallow-equal.js'
+export * from './is-deep-equal.js'

package/src/object/is-deep-equal.ts

@@ -0,0 +1,26 @@
+import { isReferenceEqual } from './is-reference-equal.js'
+import { isObject } from './is-object.js'
+
+export function isDeepEqual(a: unknown, b: unknown): boolean {
+  if (isReferenceEqual(a, b)) return true
+
+  if (isObject(a) && isObject(b)) {
+    const keysA = Reflect.ownKeys(a)
+    const keysB = Reflect.ownKeys(b)
+
+    if (keysA.length === keysB.length) {
+      for (const key of keysA) {
+        if (
+          !Object.prototype.hasOwnProperty.call(b, key) ||
+          !isDeepEqual(a[key], b[key])
+        ) {
+          return false
+        }
+      }
+
+      return true
+    }
+  }
+
+  return false
+}

package/src/object/is-reference-equal.ts

@@ -0,0 +1,3 @@
+export function isReferenceEqual(a: unknown, b: unknown): boolean {
+  return a === b
+}

package/src/object/is-shallow-equal.ts

@@ -0,0 +1,26 @@
+import { isReferenceEqual } from './is-reference-equal.js'
+import { isObject } from './is-object.js'
+
+export function isShallowEqual(a: unknown, b: unknown): boolean {
+  if (isReferenceEqual(a, b)) return true
+
+  if (isObject(a) && isObject(b)) {
+    const keysA = Reflect.ownKeys(a)
+    const keysB = Reflect.ownKeys(b)
+
+    if (keysA.length === keysB.length) {
+      for (const key of keysA) {
+        if (
+          !Object.prototype.hasOwnProperty.call(b, key) ||
+          a[key] !== b[key]
+        ) {
+          return false
+        }
+      }
+
+      return true
+    }
+  }
+
+  return false
+}