Features

Installation

# using npmnpm install dot-path-value# using pnpmpnpm install dot-path-value# using yarnyarn add dot-path-value

Usage

import{getByPath,setByPath}from'dot-path-value';constobj={a:{b:'hello',d:[{e:'world',}],},};// access through objectgetByPath(obj,'a.b');// outputs 'hello' with type `string`// access through arraygetByPath(obj,'a.d.0.e');// outputs 'world' with type `string`getByPath(obj,'a.d.0');// outputs '{ e: 'world' }' with type `{ e: string }`// also you can pass array as first argumentgetByPath([{a:1}],'0.a');// outputs '1' with type `number`// typescript errorsgetByPath(obj,'a.b.c');// `c` property does not exist// set a property through an objectsetByPath(obj,'a.b','hello there');

Types

Types usage

import{Path,PathValue}from'dot-path-value';constobj={a:{b:'hello',d:[{e:'world',}],},};typeFoo=Path<typeofobj>;// 'a.d' | 'a' | 'a.b' | `a.d.${number}` | `a.d.${number}.e`typeBar=PathValue<typeofobj,'a.b'>;// 'string'