Skip to main content
Version: 2.3

BREAK

star This is a Streamsheets Premium feature.

Immediately stops traversing a JSON object via JSON.PROCESS().

Syntax

=BREAK()

Arguments

None.

Return Value

TRUE or an error value.

Examples

Traverse only first key-value pair of following JSON

A1: {"name": "foo", "age": 42 }
A2: =CONCAT(A2, A4, "-")
A3: =CONCAT(A3, B3, "-")
A4: =BREAK()
A5: =JSON.PROCESS(JSON(A1), B3, A2:A4)
FunctionResultComment
BREAKTRUECells A2 and A3 contain only first key-value pair, namely -name- and -foo- respectively.