forIn

object

Iterates over own and inherited enumerable string keyed properties of an object and invokes iteratee for each property.

Installation

Import

import { forIn } from '@tulx/utils';

Source Code

Implementation

/**
 * Iterates over own and inherited enumerable string keyed properties of an object and invokes iteratee for each property.
 *
 * @param object - The object to iterate over.
 * @param iteratee - The function invoked per iteration.
 * @returns Returns object.
 *
 * @example
 * ```ts
 * function Foo() {
 *   this.a = 1;
 *   this.b = 2;
 * }
 * Foo.prototype.c = 3;
 * forIn(new Foo(), (value, key) => console.log(key)); // Logs 'a', 'b', then 'c'
 * ```
 */
export function forIn<T extends Record<string, unknown>>(
  object: T,
  iteratee: (value: unknown, key: string, object: T) => void
): T {
  for (const key in object) {
    iteratee(object[key], key, object);
  }
  return object;
}

Example

import { forIn } from '@tulx/utils';

function Foo() {
this.a = 1;
this.b = 2;
}
Foo.prototype.c = 3;
forIn(new Foo(), (value, key) => console.log(key)); // Logs 'a', 'b', then 'c'

Related Functions

assign

Assigns own enumerable string keyed properties of source objects to the destination object.

assignIn

This method is like assign except that it iterates over own and inherited source properties.

assignInWith

This method is like assignIn except that it accepts customizer which is invoked to produce the assigned values.

assignWith

This method is like assign except that it accepts customizer which is invoked to produce the assigned values.

Creates an array of values corresponding to paths of object.

create

Creates an object that inherits from the prototype object.