@stacksjs/objects 0.59.11 → 0.61.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/objects",
   "type": "module",
-  "version": "0.59.11",
+  "version": "0.61.0",
   "description": "The Stacks objects.",
   "author": "Chris Breuer",
   "license": "MIT",

package/src/index.ts

@@ -29,7 +29,10 @@ import { isObject } from '@stacksjs/validation'
  * // { b: 2 }
  * ```
  */
-export function objectMap<K extends string, V, NK = K, NV = V>(obj: Record<K, V>, fn: (key: K, value: V) => [NK, NV] | undefined): Record<K, V> {
+export function objectMap<K extends string, V, NK = K, NV = V>(
+  obj: Record<K, V>,
+  fn: (key: K, value: V) => [NK, NV] | undefined,
+): Record<K, V> {
   return Object.fromEntries(
     Object.entries(obj)
       .map(([k, v]) => fn(k as K, v as V))
@@ -72,13 +75,14 @@ export function objectEntries<T extends object>(obj: T) {
  *
  * @category Object
  */
-export function deepMerge<T extends object = object, S extends object = T>(target: T, ...sources: S[]): DeepMerge<T, S> {
-  if (!sources.length)
-    return target as any
+export function deepMerge<T extends object = object, S extends object = T>(
+  target: T,
+  ...sources: S[]
+): DeepMerge<T, S> {
+  if (!sources.length) return target as any
 
   const source = sources.shift()
-  if (source === undefined)
-    return target as any
+  if (source === undefined) return target as any
 
   if (isMergeableObject(target) && isMergeableObject(source)) {
     objectKeys(source).forEach((key) => {
@@ -86,13 +90,12 @@ export function deepMerge<T extends object = object, S extends object = T>(targe
       if (isMergeableObject(source[key])) {
         // @ts-expect-error some description
         if (!target[key])
-        // @ts-expect-error some description
+          // @ts-expect-error some description
           target[key] = {}
 
         // @ts-expect-error some description
         deepMerge(target[key], source[key])
-      }
-      else {
+      } else {
         // @ts-expect-error some description
         target[key] = source[key]
       }
@@ -112,13 +115,15 @@ function isMergeableObject(item: any): item is object {
  * @category Object
  */
 export function objectPick<O extends object, T extends keyof O>(obj: O, keys: T[], omitUndefined = false) {
-  return keys.reduce((n, k) => {
-    if (k in obj) {
-      if (!omitUndefined || obj[k] !== undefined)
-        n[k] = obj[k]
-    }
-    return n
-  }, {} as Pick<O, T>)
+  return keys.reduce(
+    (n, k) => {
+      if (k in obj) {
+        if (!omitUndefined || obj[k] !== undefined) n[k] = obj[k]
+      }
+      return n
+    },
+    {} as Pick<O, T>,
+  )
 }
 
 /**
@@ -127,7 +132,6 @@ export function objectPick<O extends object, T extends keyof O>(obj: O, keys: T[
  * @category Object
  */
 export function clearUndefined<T extends object>(obj: T): T {
-  // @ts-expect-error some description
   Object.keys(obj).forEach((key: string) => (obj[key] === undefined ? delete obj[key] : {}))
   return obj
 }
@@ -135,11 +139,8 @@ export function clearUndefined<T extends object>(obj: T): T {
 /**
  * Determines whether an object has a property with the specified name
  *
- * @see https://eslint.org/docs/rules/no-prototype-builtins
  * @category Object
  */
 export function hasOwnProperty<T>(obj: T, v: PropertyKey) {
-  return obj == null
-    ? false
-    : Object.prototype.hasOwnProperty.call(obj, v)
+  return obj == null ? false : Object.prototype.hasOwnProperty.call(obj, v)
 }

package/dist/index.d.ts

@@ -1,75 +0,0 @@
-import type { DeepMerge } from '@stacksjs/types';
-/**
- * Map key/value pairs for an object, and construct a new one
- *
- *
- * @category Object
- *
- * Transform:
- * @example
- * ```
- * objectMap({ a: 1, b: 2 }, (k, v) => [k.toString().toUpperCase(), v.toString()])
- * // { A: '1', B: '2' }
- * ```
- *
- * Swap key/value:
- * @example
- * ```
- * objectMap({ a: 1, b: 2 }, (k, v) => [v, k])
- * // { 1: 'a', 2: 'b' }
- * ```
- *
- * Filter keys:
- * @example
- * ```
- * objectMap({ a: 1, b: 2 }, (k, v) => k === 'a' ? undefined : [k, v])
- * // { b: 2 }
- * ```
- */
-export declare function objectMap<K extends string, V, NK = K, NV = V>(obj: Record<K, V>, fn: (key: K, value: V) => [NK, NV] | undefined): Record<K, V>;
-/**
- * Type guard for any key, `k`.
- * Marks `k` as a key of `T` if `k` is in `obj`.
- *
- * @category Object
- * @param obj object to query for key `k`
- * @param k key to check existence in `obj`
- */
-export declare function isKeyOf<T extends object>(obj: T, k: keyof any): k is keyof T;
-/**
- * Strict typed `Object.keys`
- *
- * @category Object
- */
-export declare function objectKeys<T extends object>(obj: T): (`${keyof T & undefined}` | `${keyof T & null}` | `${keyof T & string}` | `${keyof T & number}` | `${keyof T & false}` | `${keyof T & true}`)[];
-/**
- * Strict typed `Object.entries`
- *
- * @category Object
- */
-export declare function objectEntries<T extends object>(obj: T): [keyof T, T[keyof T]][];
-/**
- * Deep merge :P
- *
- * @category Object
- */
-export declare function deepMerge<T extends object = object, S extends object = T>(target: T, ...sources: S[]): DeepMerge<T, S>;
-/**
- * Create a new subset object by providing keys.
- *
- * @category Object
- */
-export declare function objectPick<O extends object, T extends keyof O>(obj: O, keys: T[], omitUndefined?: boolean): Pick<O, T>;
-/**
- * Clear undefined fields from an object. It mutates the object.
- *
- * @category Object
- */
-export declare function clearUndefined<T extends object>(obj: T): T;
-/**
- * Determines whether an object has a property with the specified name
- *
- * @see https://eslint.org/docs/rules/no-prototype-builtins
- * @category Object
- */
-export declare function hasOwnProperty<T>(obj: T, v: PropertyKey): boolean;