Function propOrCrash

  • Similar to Opt.propOrCrash, but also supports naked objects.

    Type Parameters

    • T extends object

    • P extends object | Opt<T> = T | Opt<T>

    • K extends string | number | symbol = P extends Opt<T>
          ? T extends object
              ? keyof T
              : never
          : P extends object
              ? keyof P
              : never

    Parameters

    • key: K
    • Optional errorFactory: string | ((key) => string | Error)

    Returns ((x) => WithoutOptValues<T[K]>)

    Example

    interface Animal {
    name?: string;
    }
    const a: Animal = {name: 'Spot'};
    propOrCrash<Animal>('name')(a) // 'Spot'

Generated using TypeDoc