Property Setter

Sets a property at a specified path within a copy of an object.

This node sets or adds a property at a specified path within an object.

It operates non-destructively by creating a deep copy of the input object before making any modifications. The modified copy is then available on the Object output port.

Property Paths#

Property paths use a dot-separated string to access or create nested values.

Example: - Path: render.settings.samples - This will access the samples key inside the settings dictionary, which is itself inside the render dictionary.

If any part of the path does not exist, it will be created. For example, if render.settings does not exist in the input object, it will be created as a new dictionary.

Execution Flow#

Success: If the property is set successfully, the Success execution path is triggered.
Error: If the path is invalid or an error occurs during the operation, the Error execution path is triggered.

Inputs#

Port	Description
	Executes the node.
Object	The object to modify a copy of.
Property Path	The path to the property to set. Supports dot notation (e.g., `user.address.city`). See Property Path for more info.
Property Value	The new value for the property.

Outputs#

Port	Description
Success	Executed if the property is set successfully.
Error	Executed if the path is invalid or the value cannot be set.
Object	The modified object. This is a deep copy of the input object.

ID: core/property-setter@v1