Function getByString

getByString<const T, const P extends string | number = FlattenKeys<T>>(
object: T,
path: P,
): GetByPath<T, FilterOut<Split<`${P}`, KeySeparator>, "">>

Get a value using a path of property keys.

Type Parameters

const T
const P extends string | number = FlattenKeys<T>

Parameters

object: T
path: P

Returns GetByPath<T, FilterOut<Split<`${P}`, KeySeparator>, "">>

Example

Translation keys mapping to locale objects

const locale = {
	preference: {
		theme: {
			label: 'Theme'
		}
	}
} as const;

const text = getByString(locale, 'preference.theme.label'); // 'Theme'

Example

Arrays

const pascal = {
	triangle: [
		[1],
		[1, 1],
		[1, 2, 1],
		[1, 3, 3, 1],
		[1, 4, 6, 4, 1]
	]
} as const;

const row3 = getByString(pascal, 'triangle[3]'); // readonly [1, 3, 3, 1]
const r4c3 = getByString(pascal, 'triangle[4][2]'); // 6