Skip to content

get

Get any attribute or child attribute using a deep path

190 bytes

Usage

Given any value and a select function to get the desired attribute, returns the desired value or a default value if the desired value couldn’t be found.

import * as
import _
_
from 'radashi'
const
const fish: {
name: string;
weight: number;
sizes: {
maturity: string;
range: number[];
unit: string;
}[];
}
fish
= {
name: string
name
: 'Bass',
weight: number
weight
: 8,
sizes: {
maturity: string;
range: number[];
unit: string;
}[]
sizes
: [
{
maturity: string
maturity
: 'adult',
range: number[]
range
: [7, 18],
unit: string
unit
: 'inches',
},
],
}
import _
_
.
get<unknown>(value: any, path: string, defaultValue?: unknown): unknown
export get

Dynamically get a nested value from an array or object with a string.

@seehttps://radashi.js.org/reference/object/get

@example

const person = {
name: 'John',
friends: [{ name: 'Jane' }]
}
get(person, 'friends[0].name')
// => 'Jane'

@version12.1.0

get
(
const fish: {
name: string;
weight: number;
sizes: {
maturity: string;
range: number[];
unit: string;
}[];
}
fish
, 'sizes[0].range[1]') // 18
import _
_
.
get<unknown>(value: any, path: string, defaultValue?: unknown): unknown
export get

Dynamically get a nested value from an array or object with a string.

@seehttps://radashi.js.org/reference/object/get

@example

const person = {
name: 'John',
friends: [{ name: 'Jane' }]
}
get(person, 'friends[0].name')
// => 'Jane'

@version12.1.0

get
(
const fish: {
name: string;
weight: number;
sizes: {
maturity: string;
range: number[];
unit: string;
}[];
}
fish
, 'sizes.0.range.1') // 18
import _
_
.
get<"default">(value: any, path: string, defaultValue?: "default" | undefined): "default"
export get

Dynamically get a nested value from an array or object with a string.

@seehttps://radashi.js.org/reference/object/get

@example

const person = {
name: 'John',
friends: [{ name: 'Jane' }]
}
get(person, 'friends[0].name')
// => 'Jane'

@version12.1.0

get
(
const fish: {
name: string;
weight: number;
sizes: {
maturity: string;
range: number[];
unit: string;
}[];
}
fish
, 'foo', 'default') // 'default'