objectToArray( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Adds an objectToArray stage to the aggregation pipeline.

The objectToArray() method adds a pipeline stage that converts an object into an array of objects with key-value pairs. Each property of the object becomes an element in the new array. Each element contains that property's key and value, as well as all other properties from the original object.

For example, with a destination name of variantInventory, the object { "red": 10, "blue": 5, "green": 3 } is transformed into the following array:

"variantInventory": [ { "k": "red", "v": 10 }, { "k": "blue", "v": 5 }, { "k": "green", "v": 3 } ].

Method Declaration
Copy
Method Parameters
objectFieldNamestring

Field to convert to an array. Use dot notation to specify nested fields. For example, user.name or product.price.

Learn more about field keys.


destinationFieldNamestring

Field to create in the result item.

Learn more about field keys.

Returns
Return Type:ObjectToArrayStage
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?