Skip to content

Function: objSetProp() ​

objSetProp<K, V, OutKey>(obj, key, falsyValue?, condition?, truthyValue?): Record<OutKey, V>

Defined in: packages/core/src/obj/objSetProp.ts:17

Conditionally assign value to an object's property

Type Parameters ​

K ​

K extends PropertyKey

V ​

V

OutKey ​

OutKey extends PropertyKey

Parameters ​

obj ​

Record<K, V>

target object

key ​

OutKey

object property name

falsyValue? ​

V

(optional) value to assign when condition is falsy Default: obj[key]

condition? ​

boolean | SetObPropPredicate<K, V, OutKey>

(optional) condition to determine which value to provide. Default: false

truthyValue? ​

V

(optional) value to use if condition is truthy

Returns ​

Record<OutKey, V>