@naturalcycles/js-lib 15.59.0 → 15.60.0

package/dist/array/array.util.d.ts

@@ -158,6 +158,20 @@ export declare function _intersectsWith<T>(a1: T[], a2: T[] | Set<T>): boolean;
  * Passing second array as Set is more performant (it'll skip turning the array into Set in-place).
  */
 export declare function _difference<T>(a1: T[], a2: T[] | Set<T>): T[];
+/**
+ * Does NOT mutate the array, returns a filtered array instead.
+ */
+export declare function _arrayRemove<T>(a: T[], itemToRemove: T): T[];
+/**
+ * "Toggles" an item to be present or absent in the array,
+ * based on the predicate. Respects uniqueness.
+ *
+ * If predicate==false - item gets removed from the array.
+ * If predicate==true - item gets pushed to the array (unless it was already present).
+ *
+ * Pushing the item DOES MUTATE the array, same if you would do array.push manually.
+ */
+export declare function _arrayPushOrRemove<T>(a: T[], item: T, predicate: boolean): T[];
 /**
  * Returns the sum of items, or 0 for empty array.
  */

package/dist/array/array.util.js

@@ -282,6 +282,30 @@ export function _difference(a1, a2) {
     const a2set = a2 instanceof Set ? a2 : new Set(a2);
     return a1.filter(v => !a2set.has(v));
 }
+/**
+ * Does NOT mutate the array, returns a filtered array instead.
+ */
+export function _arrayRemove(a, itemToRemove) {
+    return a.filter(r => r !== itemToRemove);
+}
+/**
+ * "Toggles" an item to be present or absent in the array,
+ * based on the predicate. Respects uniqueness.
+ *
+ * If predicate==false - item gets removed from the array.
+ * If predicate==true - item gets pushed to the array (unless it was already present).
+ *
+ * Pushing the item DOES MUTATE the array, same if you would do array.push manually.
+ */
+export function _arrayPushOrRemove(a, item, predicate) {
+    if (predicate) {
+        if (!a.includes(item)) {
+            a.push(item);
+        }
+        return a;
+    }
+    return a.filter(r => r !== item);
+}
 /**
  * Returns the sum of items, or 0 for empty array.
  */

package/dist/types.d.ts

@@ -291,14 +291,14 @@ export declare const _stringMapEntries: <T>(map: StringMap<T>) => [k: string, v:
  * Alias of `Object.keys`, but returns keys typed as `keyof T`, not as just `string`.
  * This is how TypeScript should work, actually.
  */
-export declare const _objectKeys: <K extends PropertyKey>(obj: Record<K, any>) => K[];
+export declare const _objectKeys: <K extends PropertyKey>(obj: Partial<Record<K, any>>) => K[];
 /**
  * Alias of `Object.entries`, but returns better-typed output.
  *
  * So e.g you can use _objectEntries(obj).map([k, v] => {})
  * and `k` will be `keyof obj` instead of generic `string`.
  */
-export declare const _objectEntries: <K extends PropertyKey, V>(obj: Record<K, V>) => [k: K, v: V][];
+export declare const _objectEntries: <K extends PropertyKey, V>(obj: Partial<Record<K, V>>) => [k: K, v: V][];
 export type NullishValue = null | undefined;
 export type FalsyValue = false | '' | 0 | null | undefined;
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/js-lib",
   "type": "module",
-  "version": "15.59.0",
+  "version": "15.60.0",
   "dependencies": {
     "tslib": "^2",
     "undici": "^7",

package/src/array/array.util.ts

@@ -326,6 +326,33 @@ export function _difference<T>(a1: T[], a2: T[] | Set<T>): T[] {
   return a1.filter(v => !a2set.has(v))
 }
 
+/**
+ * Does NOT mutate the array, returns a filtered array instead.
+ */
+export function _arrayRemove<T>(a: T[], itemToRemove: T): T[] {
+  return a.filter(r => r !== itemToRemove)
+}
+
+/**
+ * "Toggles" an item to be present or absent in the array,
+ * based on the predicate. Respects uniqueness.
+ *
+ * If predicate==false - item gets removed from the array.
+ * If predicate==true - item gets pushed to the array (unless it was already present).
+ *
+ * Pushing the item DOES MUTATE the array, same if you would do array.push manually.
+ */
+export function _arrayPushOrRemove<T>(a: T[], item: T, predicate: boolean): T[] {
+  if (predicate) {
+    if (!a.includes(item)) {
+      a.push(item)
+    }
+    return a
+  }
+
+  return a.filter(r => r !== item)
+}
+
 /**
  * Returns the sum of items, or 0 for empty array.
  */

package/src/types.ts

@@ -364,7 +364,9 @@ export const _stringMapEntries = Object.entries as <T>(map: StringMap<T>) => [k:
  * Alias of `Object.keys`, but returns keys typed as `keyof T`, not as just `string`.
  * This is how TypeScript should work, actually.
  */
-export const _objectKeys = Object.keys as <K extends PropertyKey>(obj: Record<K, any>) => K[]
+export const _objectKeys = Object.keys as <K extends PropertyKey>(
+  obj: Partial<Record<K, any>>,
+) => K[]
 
 /**
  * Alias of `Object.entries`, but returns better-typed output.
@@ -373,7 +375,7 @@ export const _objectKeys = Object.keys as <K extends PropertyKey>(obj: Record<K,
  * and `k` will be `keyof obj` instead of generic `string`.
  */
 export const _objectEntries = Object.entries as <K extends PropertyKey, V>(
-  obj: Record<K, V>,
+  obj: Partial<Record<K, V>>,
 ) => [k: K, v: V][]
 
 export type NullishValue = null | undefined