property

INFO

This function is only available in es-toolkit/compat for compatibility reasons. It either has alternative native JavaScript APIs or isn’t fully optimized yet.

When imported from es-toolkit/compat, it behaves exactly like lodash and provides the same functionalities, as detailed here.

Creates a function that returns the value at a given path of an object. It leverages the get functions to obtain the value.

Signature

function property(path: PropertyKey | readonly PropertyKey[]): (object: unknown) => any;

Parameters

• path (string or number or symbol or Array<string | number | symbol>): The path of the property to get.

Returns

((object: unknown) => any): A new function that takes an object and returns the value at the specified path.

Examples

import { property } from 'es-toolkit/compat';

const getObjectValue = property('a.b.c');
const result = getObjectValue({ a: { b: { c: 3 } } });
console.log(result); // => 3

const getObjectValue = property(['a', 'b', 'c']);
const result = getObjectValue({ a: { b: { c: 3 } } });
console.log(result); // => 3