Function getProperty

  • getProperty<T extends Record<string, any>>(
        target: T,
        prop: string | () => string,
        defaultValue?: any,
    ): any

  • Get array, object property values based on path string

    Type Parameters

    • T extends Record<string, any>

    Parameters

    • target: T

      target array, object

    • prop: string | () => string

      query target, can pass function

    • OptionaldefaultValue: any

      default value

    Returns any

    result

    Example

    const target = {
         a: 1,
         b: [{
             c: 2
             d: NaN
         }]
    }
    getProperty(target, 'a') // 1
    getProperty(target, 'd', 100) // 100
    getProperty(target, 'b[0].c') // 2
    getProperty(target, 'b[0].d', 100) // 100
    getProperty(target, () => 'a') // 1

    Since

    2.2.4

  • getProperty<T extends any[]>(
        target: T,
        prop: string | () => string,
        defaultValue?: any,
    ): any

  • Get array, object property values based on path string

    Type Parameters

    • T extends any[]

    Parameters

    • target: T

      target array, object

    • prop: string | () => string

      query target, can pass function

    • OptionaldefaultValue: any

      default value

    Returns any

    result

    Example

    const target = {
         a: 1,
         b: [{
             c: 2
             d: NaN
         }]
    }
    getProperty(target, 'a') // 1
    getProperty(target, 'd', 100) // 100
    getProperty(target, 'b[0].c') // 2
    getProperty(target, 'b[0].d', 100) // 100
    getProperty(target, () => 'a') // 1

    Since

    2.2.4

Settings

Member Visibility