pointless-js/src/object.ts

Functional point-free utilities for js

import { compose } from './compose';
import { createSafeOperation } from './generic';
import { Nullable } from './type';

/**
 * Applies an operation to an object safely,
 * without failing on null or undefined
 */
export const safeObj = createSafeOperation<any>({} as any);

/**
 * Gets the array of keys of the given object (type-safe)
 */
export const keys = Object.keys.bind(Object) as <T extends object>(o: T) => Array<keyof T>;

/**
 * Lazily gets a value by key chain from the object.
 *
 * Unsafe - fails when the object is `null` or `undefined`
 */
export const fromPath = (...path: string[]) => <T extends object>(obj: T): any => path.reduce((o, i) => (
  Object(o) === o ? o[i] : o
), obj);

export const key: {
  /**
   * Lazily gets a value by key from the object.
   *
   * Safe, doesn't fail even if the object is `null` or `undefined`.
   */
  <T, K extends keyof T>(key: K): (obj: Nullable<T>) => T[K];

  /**
   * Lazily gets a value by key chain from the object.
   *
   * Safe, doesn't fail even if the object is `null` or `undefined`.
   */
  (...keys: string[]): (obj: any) => any;
} = compose(
  safeObj,
  fromPath
);