@halospv3/hce.shared-config/src/utils/reflection/filterForGetters.ts

Automate commit message quality, changelogs, and CI/CD releases. Its `main` entry point is a Semantic Release config. Functions and classes are exposed for customization. An ESLint config, a Commitlint config, and addl. resources for .NET projects are als

import type {
  BaseClassProto as BaseClassPrototype,
  baseClassProto as baseClassPrototype,
  ClassLike,
  ConstructorConstraint,
  InstanceTypeOrSelf,
  SuperClassLike,
  WithProto as WithPrototype,
} from './inheritance.ts';
import type { InstancePropertyDescriptorMap } from './InstancePropertyDescriptorMap.d.ts';
import type { OwnGetterDescriptorMap } from './OwnGetterDescriptorMap.d.ts';
import type { OwnPropertyDescriptorMap } from './OwnPropertyDescriptorMap.d.ts';
import type { PropertyDescriptorMap } from './PropertyDescriptorMap.d.ts';

export function filterForGetters<
  Class extends ClassLike<ConstructorConstraint<Class> & WithPrototype<SuperClassLike | typeof baseClassPrototype>>,
>(
  descriptorMap: InstancePropertyDescriptorMap<Class>,
): Partial<OwnGetterDescriptorMap<
  InstanceType<Class>,
  Class['__proto__'] extends BaseClassPrototype ? null : InstanceTypeOrSelf<Class['__proto__']>
>>;
export function filterForGetters<
  Class extends ClassLike<ConstructorConstraint<Class> & WithPrototype<SuperClassLike | BaseClassPrototype>>,
>(
  descriptorMap: OwnPropertyDescriptorMap<Class>,
): Partial<OwnGetterDescriptorMap<Class, Class['__proto__']>>;
/**
 * Iterates through the descriptors object, checking for property descriptors whose `get` is a function.
 * Returns an {@link OwnGetterDescriptorMap} of the getters.
 * If you want only own, non-inherited getters, you must filter sanitize the
 * type the `descriptors` parameter yourself e.g. `Omit<Class, keyof
 * SuperClass>`.
 * @param descriptorMap An object like the return value of Object.getOwnPropertyDescriptors
 * @template Class Any ClassLike type
 * @template T Any `object`-like type.
 * @template [__proto__=null] If {@link Class} is not {@link ClassLike}, the `__proto__` of {@link T}.
 * @returns An {@link OwnGetterDescriptorMap}.
 * @since 3.0.0
 */
export function filterForGetters<
  T extends object,
  __prototype__ extends object | null = null,
>(
  descriptorMap: PropertyDescriptorMap<T, __prototype__> | PropertyDescriptorMap<T>,
): Partial<OwnGetterDescriptorMap<T, __prototype__>> {
  let getterDescriptorMap: Partial<OwnGetterDescriptorMap<T, __prototype__>> = {};
  for (const key in descriptorMap) {
    const element = descriptorMap[key as keyof typeof descriptorMap];
    if (typeof element.get === 'function') {
      getterDescriptorMap = Object.assign(
        getterDescriptorMap,
        { [key]: element },
      );
    }
  }

  return getterDescriptorMap;
}