deep-trails - v3.0.0-beta.3
    Preparing search index...

    Function PropertiesIterator

    • Creates an iterator for the properties of an object using a function to get its keys.

      Type Parameters

      • T extends object
      • K extends string | number | symbol = keyof T
      • V = T[K]

      Parameters

      • object: T

        The target object.

      • keysGetter: (object: T) => K[] = ...

        Function to get the object's keys. By default is Reflect.ownKeys.

      Returns EntriesIterator<
          <
              T extends object,
              K extends string | number | symbol = keyof T,
              V = T[K],
          >(
              object: T,
              keysGetter?: (object: T) => K[],
          ) => EntriesIterator<(<T extends object, K extends keyof T = keyof T, V = T[K]>(object: T, keysGetter?: (object: T) => K[]) => EntriesIterator<typeof PropertiesIterator, T, K, V>), T, K, V>,
          T,
          K,
          V,
      >

      The created iterator.

      const object = { a: 1, b: 2, c: 3 };
      const iterator = PropertiesIterator(object);

      for (const [ key, value ] of iterator) {
      console.log({ key, value });
      }

      3.0.0-beta.0